Skip to main content

NamedSource

Struct NamedSource 

Source
pub struct NamedSource<Mode = NoFallback, Shape = Whole, Spelling = Options> { /* private fields */ }
Expand description

Takes an argument’s words after its spelling, --long or -s, or from an operand name=value once .assigned(name) spells it so.

The long spelling defaults to the operation’s argument name with _ written as -. It supplies one value; .optional(), .many(), and .switch() state another shape.

Implementations§

Source§

impl NamedSource

Source

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

Declares a named source documented by doc, spelled after the argument name.

Source§

impl<Mode> NamedSource<Mode>

Source

pub fn assigned(self, name: &'static str) -> NamedSource<Mode, Whole, Assigned>

Spells the source as the operand name=value instead of an option: the value is everything after the first =, and may be empty. It takes no positional place, and no other spelling.

Source

pub fn switch(self) -> NamedSource<Mode, Switch>

Supplies bool: whether the spelling is given, with no value after it.

Source

pub fn optional_value(self) -> NamedSource<Mode, OptionalValue>

Supplies Option<Option<_>>: whether the spelling is given, and the value written in its own word, -i.bak or --in-place=.bak. The next word is never its value.

Source§

impl<Mode, Spelling> NamedSource<Mode, Whole, Spelling>

Source

pub fn optional(self) -> NamedSource<Mode, Optional, Spelling>

Supplies Option of the value: at most one occurrence.

Source

pub fn many(self) -> NamedSource<Mode, Many, Spelling>

Supplies Vec of values: one per occurrence, in order.

Source§

impl<Mode, Shape> NamedSource<Mode, Shape>

Source

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

Spells the source --long instead of after the argument name.

Source

pub fn short(self, short: char) -> Self

Also spells the source -short.

Source

pub fn short_aliases(self, aliases: &'static [char]) -> Self

Also spells the source as each of aliases, as cp -R is cp -r. Help shows them after the short spelling.

Source§

impl<Mode, Shape, Spelling> NamedSource<Mode, Shape, Spelling>

Source

pub fn env( self, name: &'static str, ) -> NamedSource<Mode::WithEnv, Shape, Spelling>
where Mode: EnvFallback,

Reads the environment variable name when the command line gives no words.

Source

pub fn default( self, word: &'static str, ) -> NamedSource<WithFallback, Shape, Spelling>

Uses word when neither the command line nor the environment gives one.

Source§

impl<Mode, Spelling> NamedSource<Mode, Many, Spelling>

Source

pub fn delimiter(self, delimiter: char) -> DelimitedSource<Mode, Spelling>

Splits every word, from the command line, the environment, or the default, on delimiter.

Trait Implementations§

Source§

impl<Mode, Shape, Spelling> CliNamedSource for NamedSource<Mode, Shape, Spelling>

Source§

impl<Decoder, Error> CliSourceDecode<(), Decoder, Error> for NamedSource<NoFallback, Switch>
where Decoder: CliWordsAlg,

Source§

fn cli_decode_source( &self, arguments: &mut &[ArgumentInfo], decoder: &Decoder, ) -> Result<(), CliArgumentError<Error>>

Decodes the argument from the words decoder gives for the arguments this source was described as, taken from the front of arguments. Read more
Source§

impl<Value, Decoder, Error> CliSourceDecode<Option<Option<Value>>, Decoder, Error> for NamedSource<NoFallback, OptionalValue>
where Decoder: CliWordsAlg + CliWordAlg<Value, Decoder::Word, Error = Error>, Decoder::Word: AsRef<OsStr>,

Source§

fn cli_decode_source( &self, arguments: &mut &[ArgumentInfo], decoder: &Decoder, ) -> Result<Option<Option<Value>>, CliArgumentError<Error>>

Decodes the argument from the words decoder gives for the arguments this source was described as, taken from the front of arguments. Read more
Source§

impl<Mode, Value, Decoder, Error, Spelling> CliSourceDecode<Option<Value>, Decoder, Error> for NamedSource<Mode, Optional, Spelling>
where Decoder: CliWordsAlg + CliWordAlg<Value, Decoder::Word, Error = Error>,

Source§

fn cli_decode_source( &self, arguments: &mut &[ArgumentInfo], decoder: &Decoder, ) -> Result<Option<Value>, CliArgumentError<Error>>

Decodes the argument from the words decoder gives for the arguments this source was described as, taken from the front of arguments. Read more
Source§

impl<Mode, Value, Decoder, Error, Spelling> CliSourceDecode<Value, Decoder, Error> for NamedSource<Mode, Whole, Spelling>
where Decoder: CliWordsAlg + CliWordAlg<Value, Decoder::Word, Error = Error>,

Source§

fn cli_decode_source( &self, arguments: &mut &[ArgumentInfo], decoder: &Decoder, ) -> Result<Value, CliArgumentError<Error>>

Decodes the argument from the words decoder gives for the arguments this source was described as, taken from the front of arguments. Read more
Source§

impl<Mode, Value, Decoder, Error, Spelling> CliSourceDecode<Vec<Value>, Decoder, Error> for NamedSource<Mode, Many, Spelling>
where Decoder: CliWordsAlg + CliWordAlg<Value, Decoder::Word, Error = Error>,

Source§

fn cli_decode_source( &self, arguments: &mut &[ArgumentInfo], decoder: &Decoder, ) -> Result<Vec<Value>, CliArgumentError<Error>>

Decodes the argument from the words decoder gives for the arguments this source was described as, taken from the front of arguments. Read more
Source§

impl<Decoder, Error> CliSourceDecode<bool, Decoder, Error> for NamedSource<NoFallback, Switch>
where Decoder: CliWordsAlg + CliWordAlg<bool, Decoder::Word, Error = Error>, Decoder::Word: AsRef<OsStr>,

Source§

fn cli_decode_source( &self, arguments: &mut &[ArgumentInfo], decoder: &Decoder, ) -> Result<bool, CliArgumentError<Error>>

Decodes the argument from the words decoder gives for the arguments this source was described as, taken from the front of arguments. Read more
Source§

impl<Decoder, Error> CliSourceDecode<bool, Decoder, Error> for NamedSource<WithEnv, Switch>
where Decoder: CliWordsAlg + CliWordAlg<bool, Decoder::Word, Error = Error>, Decoder::Word: AsRef<OsStr>,

Source§

fn cli_decode_source( &self, arguments: &mut &[ArgumentInfo], decoder: &Decoder, ) -> Result<bool, CliArgumentError<Error>>

Decodes the argument from the words decoder gives for the arguments this source was described as, taken from the front of arguments. Read more
Source§

impl CliSourceFor<()> for NamedSource<NoFallback, Switch>

An alternative of a sum carrying no value: given by its spelling alone.

Source§

fn cli_describe( &self, name: &'static str, positions: &mut usize, out: &mut Vec<ArgumentInfo>, )

Describes this source for the argument name into out, counting positional sources in positions. A compound source describes one argument per part.
Source§

impl<Value> CliSourceFor<Option<Option<Value>>> for NamedSource<NoFallback, OptionalValue>

An option with a value written only in its own word: absent, given bare, which an interpreter answers as an empty word, or given a value.

Source§

fn cli_describe( &self, name: &'static str, positions: &mut usize, out: &mut Vec<ArgumentInfo>, )

Describes this source for the argument name into out, counting positional sources in positions. A compound source describes one argument per part.
Source§

impl<Mode, Value, Spelling: CliSpelling> CliSourceFor<Option<Value>> for NamedSource<Mode, Optional, Spelling>

Source§

fn cli_describe( &self, name: &'static str, positions: &mut usize, out: &mut Vec<ArgumentInfo>, )

Describes this source for the argument name into out, counting positional sources in positions. A compound source describes one argument per part.
Source§

impl<Mode, Value, Spelling: CliSpelling> CliSourceFor<Value> for NamedSource<Mode, Whole, Spelling>

Source§

fn cli_describe( &self, name: &'static str, positions: &mut usize, out: &mut Vec<ArgumentInfo>, )

Describes this source for the argument name into out, counting positional sources in positions. A compound source describes one argument per part.
Source§

impl<Mode, Value, Spelling: CliSpelling> CliSourceFor<Vec<Value>> for NamedSource<Mode, Many, Spelling>

Source§

fn cli_describe( &self, name: &'static str, positions: &mut usize, out: &mut Vec<ArgumentInfo>, )

Describes this source for the argument name into out, counting positional sources in positions. A compound source describes one argument per part.
Source§

impl CliSourceFor<bool> for NamedSource<NoFallback, Switch>

Source§

fn cli_describe( &self, name: &'static str, positions: &mut usize, out: &mut Vec<ArgumentInfo>, )

Describes this source for the argument name into out, counting positional sources in positions. A compound source describes one argument per part.
Source§

impl CliSourceFor<bool> for NamedSource<WithEnv, Switch>

Source§

fn cli_describe( &self, name: &'static str, positions: &mut usize, out: &mut Vec<ArgumentInfo>, )

Describes this source for the argument name into out, counting positional sources in positions. A compound source describes one argument per part.
Source§

impl<Mode: Clone, Shape: Clone, Spelling: Clone> Clone for NamedSource<Mode, Shape, Spelling>

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<Mode: Copy, Shape: Copy, Spelling: Copy> Copy for NamedSource<Mode, Shape, Spelling>

Source§

impl<Mode: Debug, Shape: Debug, Spelling: Debug> Debug for NamedSource<Mode, Shape, Spelling>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<Mode, Shape, Spelling> Freeze for NamedSource<Mode, Shape, Spelling>

§

impl<Mode, Shape, Spelling> RefUnwindSafe for NamedSource<Mode, Shape, Spelling>

§

impl<Mode, Shape, Spelling> Send for NamedSource<Mode, Shape, Spelling>

§

impl<Mode, Shape, Spelling> Sync for NamedSource<Mode, Shape, Spelling>

§

impl<Mode, Shape, Spelling> Unpin for NamedSource<Mode, Shape, Spelling>

§

impl<Mode, Shape, Spelling> UnsafeUnpin for NamedSource<Mode, Shape, Spelling>

§

impl<Mode, Shape, Spelling> UnwindSafe for NamedSource<Mode, Shape, Spelling>

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, Args, const INDEX: usize> CliSourceAt<Args, INDEX> for Source
where Args: CliArgAt<INDEX>, Source: CliSourceFor<<Args as CliArgAt<INDEX>>::Arg>,

Source§

impl<Source> CliStatedFor<ContextArg> for Source

Source§

impl<Source, Arg> CliStatedFor<StatedArg<Arg>> for Source
where Source: CliSourceFor<Arg>,

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.