mirai-console/net.mamoe.mirai.console.util

Package net.mamoe.mirai.console.util

Types

open class AnsiMessageBuilder(val delegate: StringBuilder) : Appendable, Serializable

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CONSTRUCTOR])

annotation class ConsoleExperimentalApi(val message: String = "")

标记一个实验性的 API.

ConsoleInput

interface ConsoleInput

Console 输入. 由于 console 接管了标准输入, readLine 等操作需要在这里进行.

ConsoleInternalApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class ConsoleInternalApi(val message: String = "")

标记为一个仅供 mirai-console 内部使用的 API.

ContactUtils

@ConsoleExperimentalApi

object ContactUtils

为简化操作提供的一些工具

MessageScope

interface MessageScope

表示几个消息对象的 '域', 即消息对象的集合. 用于最小化将同一条消息发送给多个类型不同的目标的付出.

MessageUtils

@ConsoleExperimentalApi

object MessageUtils

SemVersion

data class SemVersion : Comparable<SemVersion>

语义化版本支持

Functions

AnsiMessageBuilder

fun AnsiMessageBuilder(capacity: Int = 16): AnsiMessageBuilder

asMessageScope

fun CommandSender.asMessageScope(): MessageScope

fun Contact.asMessageScope(): MessageScope

buildAnsiMessage

inline fun buildAnsiMessage(capacity: Int = 16, action: AnsiMessageBuilder.() -> Unit): String

构建一条 ANSI 信息

cast

inline fun <T : Any> Any?.cast(): T

Perform this as T.

invoke

inline operator fun <R, MS : MessageScope> MS.invoke(action: MS.() -> R): R

使用 MessageScope 里的所有消息对象. 与 kotlin.run 相同.

requestInput

inline suspend fun MiraiConsole.requestInput(hint: String): String

retryCatching

inline fun <R> retryCatching(n: @Range(from = 1, to = 2147483647) Int, block: () -> R): Result<R>

执行 n 次 block, 在第一次成功时返回执行结果, 在捕获到异常时返回异常.

safeCast

inline fun <T : Any> Any?.safeCast(): T?

Perform this as? T.

scopeWith

~~inline~~ ~~fun~~ CommandSender.~~scopeWith~~(): MessageScope

~~inline~~ ~~fun~~ MessageScope.~~scopeWith~~(): MessageScope

~~inline~~ ~~fun~~ Contact.~~scopeWith~~(): MessageScope

~~inline~~ ~~fun~~ <R> CommandSender.~~scopeWith~~(action: MessageScope.() -> R): R

fun CommandSender?.scopeWith(vararg others: CommandSender?): MessageScope

fun CommandSender?.scopeWith(vararg others: MessageScope?): MessageScope

fun CommandSender?.scopeWith(vararg others: Contact?): MessageScope

fun CommandSender?.scopeWith(other: CommandSender?): MessageScope

fun CommandSender?.scopeWith(other: MessageScope?): MessageScope

fun CommandSender?.scopeWith(other: Contact?): MessageScope

~~inline~~ ~~fun~~ <R> MessageScope.~~scopeWith~~(action: MessageScope.() -> R): R

fun MessageScope?.scopeWith(vararg others: CommandSender?): MessageScope

fun MessageScope?.scopeWith(vararg others: MessageScope?): MessageScope

fun MessageScope?.scopeWith(vararg others: Contact?): MessageScope

fun MessageScope?.scopeWith(other: CommandSender?): MessageScope

fun MessageScope?.scopeWith(other: MessageScope?): MessageScope

fun MessageScope?.scopeWith(other: Contact?): MessageScope

~~inline~~ ~~fun~~ <R> Contact.~~scopeWith~~(action: MessageScope.() -> R): R

fun Contact?.scopeWith(vararg others: CommandSender?): MessageScope

fun Contact?.scopeWith(vararg others: MessageScope?): MessageScope

fun Contact?.scopeWith(vararg others: Contact?): MessageScope

fun Contact?.scopeWith(other: CommandSender?): MessageScope

fun Contact?.scopeWith(other: MessageScope?): MessageScope

fun Contact?.scopeWith(other: Contact?): MessageScope

inline fun <R> CommandSender?.scopeWith(vararg others: CommandSender?, action: MessageScope.() -> R): R

inline fun <R> CommandSender?.scopeWith(vararg others: MessageScope?, action: MessageScope.() -> R): R

inline fun <R> CommandSender?.scopeWith(vararg others: Contact?, action: MessageScope.() -> R): R

inline fun <R> MessageScope?.scopeWith(vararg others: CommandSender?, action: MessageScope.() -> R): R

inline fun <R> MessageScope?.scopeWith(vararg others: MessageScope?, action: MessageScope.() -> R): R

inline fun <R> MessageScope?.scopeWith(vararg others: Contact?, action: MessageScope.() -> R): R

inline fun <R> Contact?.scopeWith(vararg others: CommandSender?, action: MessageScope.() -> R): R

inline fun <R> Contact?.scopeWith(vararg others: MessageScope?, action: MessageScope.() -> R): R

inline fun <R> Contact?.scopeWith(vararg others: Contact?, action: MessageScope.() -> R): R

sendAnsiMessage

inline suspend fun CommandSender.sendAnsiMessage(message: String): MessageReceipt<Contact>?

inline suspend fun CommandSender.sendAnsiMessage(capacity: Int = 16, builder: AnsiMessageBuilder.() -> Unit): MessageReceipt<Contact>?

向 CommandSender 发送一条带有 ANSI 控制符的信息

toMessageScope

@JvmName(name = "toMessageScopeCommandSenderArray")

fun Array<CommandSender?>.toMessageScope(): MessageScope

@JvmName(name = "toMessageScopeMessageScopeArray")

fun Array<MessageScope?>.toMessageScope(): MessageScope

@JvmName(name = "toMessageScopeContactArray")

fun Array<Contact?>.toMessageScope(): MessageScope

@JvmName(name = "toMessageScopeCommandSenderIterable")

fun Iterable<CommandSender?>.toMessageScope(): MessageScope

@JvmName(name = "toMessageScopeMessageScopeIterable")

fun Iterable<MessageScope?>.toMessageScope(): MessageScope

@JvmName(name = "toMessageScopeContactIterable")

fun Iterable<Contact?>.toMessageScope(): MessageScope

@JvmName(name = "toMessageScopeCommandSenderSequence")

fun Sequence<CommandSender?>.toMessageScope(): MessageScope

@JvmName(name = "toMessageScopeMessageScopeSequence")

fun Sequence<MessageScope?>.toMessageScope(): MessageScope

@JvmName(name = "toMessageScopeContactSequence")

fun Sequence<Contact?>.toMessageScope(): MessageScope

@JvmName(name = "toMessageScopeCommandSenderFlow")

suspend fun Flow<CommandSender>.toMessageScope(): MessageScope

@JvmName(name = "toMessageScopeMessageScopeFlow")

suspend fun Flow<MessageScope>.toMessageScope(): MessageScope

@JvmName(name = "toMessageScopeContactFlow")

suspend fun Flow<Contact>.toMessageScope(): MessageScope