Skip to main content

Console

Struct Console 

Source
pub struct Console { /* private fields */ }
Expand description

控制台应用 — 命令注册表与分发器

对齐 PHP think\console\Console。允许在运行时注册自定义命令, 并列出所有可用命令。

§分发逻辑

  1. args[1] 匹配已注册的自定义命令名,则分发到该命令
  2. 否则,回退到内置的 clap CLI(crate::run

§示例

use sz_rust_cli::{Console, Command, CommandSignature};

let mut console = Console::new();
console.register(Box::new(MyCommand));
console.run(vec!["sz-rust".to_string(), "my:command".to_string()]);

Implementations§

Source§

impl Console

Source

pub fn new() -> Self

创建空的 Console 实例

Source

pub fn register(&mut self, command: Box<dyn Command>) -> &mut Self

注册自定义命令

对齐 PHP think\console\Console::add(Command $command)

§参数
  • command:实现了 Command trait 的命令实例(装箱)
§返回

返回 &mut Self 以支持链式调用。

§示例
let mut console = Console::new();
console
    .register(Box::new(HelloCommand))
    .register(Box::new(WorldCommand));
Source

pub fn run(&self, args: Vec<String>) -> Result<i32, CliError>

运行控制台

args[1](程序名后的首个参数)匹配已注册的自定义命令名, 则分发到该命令;否则回退到内置 clap CLI。

§参数
  • args:命令行参数(含程序名,如 ["sz-rust", "hello", "arg1"]
§返回
  • Ok(0):成功
  • Ok(code):命令指定的退出码
  • Err(_):内部错误
Source

pub fn list(&self) -> Vec<CommandSignature>

列出所有已注册的自定义命令签名

对齐 PHP think\console\Console::getCommands()

§返回

返回命令签名向量,顺序不保证(HashMap 迭代顺序不确定)。

Source

pub fn print_list(&self)

打印命令列表到标准输出

对齐 PHP think\console\Console::listCommands()

Trait Implementations§

Source§

impl Default for Console

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more