Skip to main content

CliHints

Struct CliHints 

Source
pub struct CliHints {
    pub usage: String,
    pub aliases: Vec<String>,
    pub format: String,
    pub hidden: bool,
    pub default: bool,
    pub skip: bool,
    pub daemon: bool,
    pub before: String,
    pub after: String,
    pub fields: HashMap<String, CliFieldHint>,
}
Expand description

CliHints 是 CLI 前端的命令级配置。字段级绑定可以放在入参 struct 的 cli 属性上,也可以放在 Fields(按字段 JSON 名或 Rust 名索引)。Fields 条目合并覆盖属性绑定——零值 hint 字段保留属性值,因此可以只在属性里 设短名、只在构建器里改默认值。

Fields§

§usage: String

单行调用式,如 “add ”。

§aliases: Vec<String>

等价的子命令拼写。

§format: String

逐命令的默认输出格式(spec §10.7 第三层):“”=沿用全局; 取 auto|text|json|jsonl|markdown。低于命令行两层、高于 Config。

§hidden: bool

从帮助列表里隐藏。

§default: bool

使该命令成为其父节点的默认子命令:首段不是已注册命令段(且不是 flag)时,整串参数不消费地转发给它(udf image.tar ⇔ udf extract image.tar,当 extract 标记了 default)。

§skip: bool

从 CLI 通道整体移除该命令:不建子命令、别名不生效、不出现在 completion。与 hidden 的区别:hidden 只藏帮助、仍可执行。

§daemon: bool

声明「长驻命令」:handler 阻塞到 ctx 取消再返回。语义:隐含 HTTP/MCP 双排除(通道层面不消费);执行时不渲染返回值(handler 的 error 照常分类);ctx 取消即优雅关停、退出 0。

§before: String

-h 帮助的自定义文本块:分别插在帮助最前(description 之前)与 最后(Global Flags 之后)。原样输出(多行、缩进自控;结尾换行归一)。 空 = 不插入。仅叶子命令生效(中间节点没有 CliHints)。

§after: String§fields: HashMap<String, CliFieldHint>

Trait Implementations§

Source§

impl Clone for CliHints

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CliHints

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for CliHints

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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