Skip to main content

Conventions

Struct Conventions 

Source
pub struct Conventions {
    pub options_first: bool,
    pub unknown_options_are_operands: bool,
    pub double_dash_ends_options: bool,
    pub verbatim: bool,
    pub numeric_option: Option<&'static str>,
}
Expand description

States how one command’s words are read as its options and operands.

The default reads options anywhere among the operands, rejects an option no argument is spelled as, ends options at --, and answers --help and -h with help. POSIX utilities differ per command, and a declaration states where one does.

Fields§

§options_first: bool

Options end at the first operand: echo hello -n has two operands.

§unknown_options_are_operands: bool

A word naming an option no argument is spelled as is an operand, as is a cluster with one such letter: echo -x writes -x.

§double_dash_ends_options: bool

-- ends the options. Where it does not, it is an operand like any other word.

§verbatim: bool

Every word is an operand, operands beyond the command’s own are ignored, and help is not answered: true --help exits 0.

§numeric_option: Option<&'static str>

The long spelling of the option a word of a dash and digits gives its digits to: head -5 is head --lines 5.

Trait Implementations§

Source§

impl Clone for Conventions

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 Copy for Conventions

Source§

impl Debug for Conventions

Source§

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

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

impl Default for Conventions

Source§

fn default() -> Self

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

impl Eq for Conventions

Source§

impl PartialEq for Conventions

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Conventions

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<This> CliDeclarationLawsExt<This> for This

Source§

fn law_cli_declaration<Operation, Sources, Mode, Commands>( &self, name: &'static str, operation: Operation, sources: Sources, mode: Mode, conventions: Conventions, ) -> Result<(), &'static str>
where This: CliOperationAlg<Operation, Sources, Mode, Commands = Commands> + CliCommandsObserved<Commands = Commands>, Operation: OperationAlg, Sources: CliSources<<Operation as OperationAlg>::Args>,

Checks that operation declared under name with sources describes exactly that, with one argument per operation argument, in order, and distinct spellings and positions.

Source§

impl<This> CliOutcomeLawsExt<This> for This

Source§

fn law_cli_outcome<Output>(&self, output: Output) -> Result<(), &'static str>
where This: CliOutcomeOf<Output>, <This as CliOutcomeOf<Output>>::Error: CliFailureAlg,

Checks that output read under this mode exits with zero exactly when it succeeds.

Source§

impl<Source> CliPartsFor<ContextArg> for Source

Source§

const PARTS: &'static [&'static str] = const PARTS: &'static [&'static str] = &[];

The argument’s part names, in order.
Source§

const PART: &'static str = const PART: &'static str = "part";

What one part is called: field or alternative.
Source§

const WHOLE: &'static str = const WHOLE: &'static str = "argument";

What the whole is called: product or sum.
Source§

impl<This> CliProgramExt<This> for This

Source§

fn compile_cli<Program>( &self, program: Program, ) -> <Program as CliProgramAlg<This>>::Commands
where Program: CliProgramAlg<This>,

Compiles a named CLI program with this interpreter.

Source§

impl<Source> CliStatedFor<ContextArg> for Source

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<This> ShapeProgramExt<This> for This

Source§

fn compile_shape<Program>( &self, program: Program, ) -> <Program as ShapeProgramAlg<This>>::Ty
where Program: ShapeProgramAlg<This>,

Folds a declaration with this interpretation.

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.