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<Mode> PositionalSource<Mode>
impl<Mode> PositionalSource<Mode>
Sourcepub fn optional(self) -> PositionalSource<Mode, Optional>
pub fn optional(self) -> PositionalSource<Mode, Optional>
Supplies Option of the value: at most one word.
Sourcepub fn many(self) -> PositionalSource<Mode, Many>
pub fn many(self) -> PositionalSource<Mode, Many>
Supplies Vec of values: every remaining positional word.
Source§impl<Mode, Shape> PositionalSource<Mode, Shape>
impl<Mode, Shape> PositionalSource<Mode, Shape>
Sourcepub fn env(self, name: &'static str) -> PositionalSource<Mode::WithEnv, Shape>where
Mode: EnvFallback,
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.
Sourcepub fn default(
self,
word: &'static str,
) -> PositionalSource<WithFallback, Shape>
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>
impl<Mode, Value, Decoder, Error> CliSourceDecode<Option<Value>, Decoder, Error> for PositionalSource<Mode, Optional>
Source§fn cli_decode_source(
&self,
arguments: &mut &[ArgumentInfo],
decoder: &Decoder,
) -> Result<Option<Value>, CliArgumentError<Error>>
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 moreSource§impl<Mode, Value, Decoder, Error> CliSourceDecode<Value, Decoder, Error> for PositionalSource<Mode, Whole>
impl<Mode, Value, Decoder, Error> CliSourceDecode<Value, Decoder, Error> for PositionalSource<Mode, Whole>
Source§fn cli_decode_source(
&self,
arguments: &mut &[ArgumentInfo],
decoder: &Decoder,
) -> Result<Value, CliArgumentError<Error>>
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 moreSource§impl<Mode, Value, Decoder, Error> CliSourceDecode<Vec<Value>, Decoder, Error> for PositionalSource<Mode, Many>
impl<Mode, Value, Decoder, Error> CliSourceDecode<Vec<Value>, Decoder, Error> for PositionalSource<Mode, Many>
Source§fn cli_decode_source(
&self,
arguments: &mut &[ArgumentInfo],
decoder: &Decoder,
) -> Result<Vec<Value>, CliArgumentError<Error>>
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 moreSource§impl<Mode, Value> CliSourceFor<Option<Value>> for PositionalSource<Mode, Optional>
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>,
)
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>
impl<Mode, Value> CliSourceFor<Value> for PositionalSource<Mode, Whole>
Source§fn cli_describe(
&self,
name: &'static str,
positions: &mut usize,
out: &mut Vec<ArgumentInfo>,
)
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>
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>,
)
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.impl<Mode: Copy, Shape: Copy> Copy for PositionalSource<Mode, Shape>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<This> CliDeclarationLawsExt<This> for This
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>,
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
impl<This> CliOutcomeLawsExt<This> for This
Source§impl<Source> CliPartsFor<ContextArg> for Source
impl<Source> CliPartsFor<ContextArg> for Source
Source§impl<This> CliProgramExt<This> for This
impl<This> CliProgramExt<This> for This
Source§fn compile_cli<Program>(
&self,
program: Program,
) -> <Program as CliProgramAlg<This>>::Commandswhere
Program: CliProgramAlg<This>,
fn compile_cli<Program>(
&self,
program: Program,
) -> <Program as CliProgramAlg<This>>::Commandswhere
Program: CliProgramAlg<This>,
Compiles a named CLI program with this interpreter.
impl<Source, Args, const INDEX: usize> CliSourceAt<Args, INDEX> for Source
impl<Source> CliStatedFor<ContextArg> for Source
impl<Source, Arg> CliStatedFor<StatedArg<Arg>> for Sourcewhere
Source: CliSourceFor<Arg>,
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<This> ShapeProgramExt<This> for This
impl<This> ShapeProgramExt<This> for This
Source§fn compile_shape<Program>(
&self,
program: Program,
) -> <Program as ShapeProgramAlg<This>>::Tywhere
Program: ShapeProgramAlg<This>,
fn compile_shape<Program>(
&self,
program: Program,
) -> <Program as ShapeProgramAlg<This>>::Tywhere
Program: ShapeProgramAlg<This>,
Folds a declaration with this interpretation.