Struct CmdSpec 

pub struct CmdSpec {
    pub name: &'static str,
    pub doc: &'static str,
}

Specification for Cmd.

Fields

name: &'static str

Subcommand name (usually cebab-case).

doc: &'static str

Documentation.

Implementations

impl CmdSpec

pub const DEFAULT: Self

The default specification.

pub const fn new(name: &'static str) -> Self

Makes an CmdSpec instance with a specified name (equivalent to noargs::cmd(name)).

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

Updates the value of CmdSpec::doc.

pub fn take(self, args: &mut RawArgs) -> Cmd

Takes the first Cmd instance that satisfies this specification from the raw arguments.

Trait Implementations

impl Clone for CmdSpec

fn clone(&self) -> CmdSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CmdSpec

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

Formats the value using the given formatter.

impl Default for CmdSpec

fn default() -> Self

Returns the “default value” for a type.

impl Hash for CmdSpec

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CmdSpec

fn eq(&self, other: &CmdSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for CmdSpec

impl Eq for CmdSpec

impl StructuralPartialEq for CmdSpec