mirai-console/net.mamoe.mirai.console.command.descriptor/CommandValueArgumentParser

CommandValueArgumentParser

interface CommandValueArgumentParser<out T : Any>

指令参数解析器. 用于解析字符串或 SingleMessage 到特定参数类型.

参数解析

如 SimpleCommand 中的示例:

suspend fun CommandSender.mute(target: Member, duration: Int)

CommandManager 总是从 SimpleCommand.context 搜索一个 T 为 Member 的 CommandValueArgumentParser, 并调用其 CommandValueArgumentParser.parse

内建指令解析器

基础类型: ByteValueArgumentParser, ShortValueArgumentParser, IntValueArgumentParser, LongValueArgumentParser, DoubleValueArgumentParser, BooleanValueArgumentParser, StringValueArgumentParser

See also

net.mamoe.mirai.console.command.SimpleCommand

简单指令

net.mamoe.mirai.console.command.CompositeCommand

复合指令

buildCommandArgumentContext

指令参数环境, 即 CommandValueArgumentParser 的集合

Types

Companion

object Companion

Functions

parse

abstract fun parse(raw: String, sender: CommandSender): T

解析一个字符串为 T 类型参数

open fun parse(raw: MessageContent, sender: CommandSender): T

解析一个消息内容元素为 T 类型参数

Inheritors

RawContentValueArgumentParser

AbstractCommandValueArgumentParser

Parser

Parser

Extensions

map

fun <Original : Any, Result : Any> CommandValueArgumentParser<Original>.map(mapper: MappingCommandValueArgumentParser<Original, Result>.(Original) -> Result): CommandValueArgumentParser<Result>

使用原 this 解析, 成功后使用 mapper 映射为另一个类型.

parse

fun <T : Any> CommandValueArgumentParser<T>.parse(raw: Message, sender: CommandSender): T

解析一个字符串或 SingleMessage 为 T 类型参数