puniyu_types 0.7.7

puniyu 通用类型库
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

mod arg;
pub use arg::*;

use crate::context::MessageContext;
use crate::event::Permission;
use crate::handler::HandlerResult;
use async_trait::async_trait;

/// 命令处理动作
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CommandAction {
	/// 处理完成，停止传播
	Done,
	/// 继续传播给其他处理器
	Continue,
}

impl CommandAction {
	pub const fn done() -> HandlerResult<CommandAction> {
		Ok(CommandAction::Done)
	}
	pub const fn r#continue() -> HandlerResult<CommandAction> {
		Ok(CommandAction::Continue)
	}
}

impl From<()> for CommandAction {
	fn from(_: ()) -> Self {
		CommandAction::Done
	}
}

/// 命令
#[derive(Debug, Clone)]
pub struct Command<'c> {
	pub name: &'c str,
	pub description: Option<&'c str>,
	pub args: Vec<Arg<'c>>,
	pub rank: u32,
	/// 自定义前缀，None 表示使用全局前缀
	pub prefix: Option<String>,
	/// 命令别名
	pub alias: Vec<&'c str>,
	/// 权限等级
	pub permission: Permission,
}

#[async_trait]
pub trait CommandBuilder: Send + Sync + 'static {
	/// 命令名称
	fn name(&self) -> &'static str;

	/// 描述
	fn description(&self) -> Option<&'static str> {
		None
	}

	/// 参数列表
	fn args(&'_ self) -> Vec<Arg<'static>> {
		Vec::new()
	}

	/// 优先级
	fn rank(&self) -> u32 {
		500
	}

	/// 命令别名
	fn alias(&self) -> Vec<&'static str> {
		Vec::new()
	}

	/// 权限等级
	fn permission(&self) -> Permission {
		Permission::All
	}

	/// 执行的函数
	async fn run(&self, ctx: &MessageContext) -> HandlerResult<CommandAction>;
}