Skip to main content

PositionalSource

Struct PositionalSource 

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

Takes an argument’s words by position, in the order the positional arguments are declared.

It supplies one value; .optional() and .many() state another shape.

Implementations§

Source§

impl PositionalSource

Source

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

Declares a positional source documented by doc.

Source§

impl<Mode> PositionalSource<Mode>

Source

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

Supplies Option of the value: at most one word.

Source

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

Supplies Vec of values: every remaining positional word.

Source§

impl<Mode, Shape> PositionalSource<Mode, Shape>

Source

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

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

Source

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

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

Trait Implementations§

Source§

impl<Mode, Value, Decoder, Error> CliSourceDecode<Option<Value>, Decoder, Error> for PositionalSource<Mode, Optional>
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> CliSourceDecode<Value, Decoder, Error> for PositionalSource<Mode, Whole>
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> CliSourceDecode<Vec<Value>, Decoder, Error> for PositionalSource<Mode, Many>
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<Mode, Value> CliSourceFor<Option<Value>> for PositionalSource<Mode, Optional>

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> CliSourceFor<Value> for PositionalSource<Mode, Whole>

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> CliSourceFor<Vec<Value>> for PositionalSource<Mode, Many>

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> Clone for PositionalSource<Mode, Shape>

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> Copy for PositionalSource<Mode, Shape>

Source§

impl<Mode: Debug, Shape: Debug> Debug for PositionalSource<Mode, Shape>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<Mode, Shape> Freeze for PositionalSource<Mode, Shape>

§

impl<Mode, Shape> RefUnwindSafe for PositionalSource<Mode, Shape>

§

impl<Mode, Shape> Send for PositionalSource<Mode, Shape>

§

impl<Mode, Shape> Sync for PositionalSource<Mode, Shape>

§

impl<Mode, Shape> Unpin for PositionalSource<Mode, Shape>

§

impl<Mode, Shape> UnsafeUnpin for PositionalSource<Mode, Shape>

§

impl<Mode, Shape> UnwindSafe for PositionalSource<Mode, Shape>

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