Skip to main content

Directive

Struct Directive 

Source
pub struct Directive {
    pub cli_flag: &'static str,
    pub help: Option<&'static str>,
    pub values: Option<ClosedValues>,
    pub boolean: bool,
    pub repeatable: bool,
    pub yaml_directive: Option<&'static str>,
}
Expand description

A richer flag descriptor that bundles the CLI form, optional YAML mirror, value semantics, and repeatability into one declaration. Adapters can expand a &[Directive] into per-flag completion + parse rules without the caller writing a parallel translation layer.

Maps roughly to nbrs’s vocab::Directive shape — a directive is “the canonical statement of what a flag IS, in every surface it appears.” Use apply_directives to register a slice of directives onto a Node in one call.

Fields§

§cli_flag: &'static str

CLI form, e.g. "--metric". Required.

§help: Option<&'static str>

One-line help text. Optional.

§values: Option<ClosedValues>

Closed value set for both completion and validation. None means free-form value (or boolean).

§boolean: bool

true for boolean flags (no value expected).

§repeatable: bool

true when this flag may appear multiple times. Currently informational; reserved for downstream parsers/validators.

§yaml_directive: Option<&'static str>

Optional YAML directive mirror. Currently informational; lets downstream YAML parsers cross-reference the same Directive.

Implementations§

Source§

impl Directive

Source

pub const fn closed( cli_flag: &'static str, values: &'static [&'static str], ) -> Self

Construct a value-taking directive with a closed set.

Source

pub const fn value(cli_flag: &'static str) -> Self

Construct a free-form value-taking directive.

Source

pub const fn boolean(cli_flag: &'static str) -> Self

Construct a boolean-flag directive.

Source

pub const fn with_help(self, help: &'static str) -> Self

Builder: attach help text.

Source

pub const fn repeatable(self) -> Self

Builder: mark as repeatable.

Source

pub const fn with_yaml(self, name: &'static str) -> Self

Builder: attach the YAML mirror directive name.

Trait Implementations§

Source§

impl Clone for Directive

Source§

fn clone(&self) -> Directive

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 Directive

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = 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.