Skip to main content

Stop

Struct Stop 

Source
pub struct Stop;
Expand description

A special option value, can stop the policy, using for implement --.

§Example

use aopt::prelude::*;

fn main() -> Result<(), Box<dyn std::error::Error>> {

    let mut parser = AFwdParser::default();

    parser.add_opt("stop".infer::<aopt::value::Stop>())?;

    // -w will processed, it is set before `--`
    parser.add_opt("-w=i")?;

    // -o will not processed, it is set after `--`
    parser.add_opt("-o=s")?;

    // fo will processed, it is not an option
    parser.add_opt("foo=p@1")?;

    parser.parse(Args::from(["app", "-w=42", "--", "-o", "val", "foo"]))?;

    assert_eq!(parser.find_val::<i64>("-w")?, &42);
    assert!(parser.find_val::<String>("-o").is_err());
    assert_eq!(parser.find_val::<bool>("foo")?, &true);
    Ok(())
}
POSIX.1-2017

12.2 Utility Syntax Guidelines

Guideline 10:

The first -- argument that is not an option-argument should be accepted as a delimiter indicating the end of options.
Any following arguments should be treated as operands, even if they begin with the '-' character.

Trait Implementations§

Source§

impl Clone for Stop

Source§

fn clone(&self) -> Stop

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Stop

Source§

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

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

impl Default for Stop

Source§

fn default() -> Stop

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

impl<'de> Deserialize<'de> for Stop

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Infer for Stop

Source§

fn infer_tweak_info<C>(cfg: &mut C) -> Result<(), Error>
where Self: Sized + 'static, Self::Val: RawValParser, C: ConfigValue + Default,

For type Stop, swap the name and default alias(--) when build configuration.

Source§

type Val = Stop

Source§

fn infer_act() -> Action

Source§

fn infer_style() -> Vec<Style>

Source§

fn infer_ignore_alias() -> bool

Source§

fn infer_map(val: Self::Val) -> Self

Source§

fn infer_force() -> bool

Source§

fn infer_ctor() -> String

Source§

fn infer_index() -> Option<Index>

Source§

fn infer_ignore_name() -> bool

Source§

fn infer_ignore_index() -> bool

Source§

fn infer_validator() -> Option<ValValidator<Self::Val>>

Source§

fn infer_initializer() -> Option<ValInitializer>

Source§

fn infer_type_id() -> TypeId

Source§

fn infer_mutable(&mut self, val: Self::Val)
where Self: Sized,

Source§

fn infer_fill_info<C>(cfg: &mut C) -> Result<(), Error>
where Self: Sized + 'static, Self::Val: RawValParser, C: ConfigValue + Default,

Source§

impl Ord for Stop

Source§

fn cmp(&self, other: &Stop) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Stop

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for Stop

Source§

fn partial_cmp(&self, other: &Stop) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl RawValParser for Stop

Source§

type Error = Error

Source§

fn parse(raw: Option<&OsStr>, ctx: &Ctx<'_>) -> Result<Self, Self::Error>

Source§

impl Serialize for Stop

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for Stop

Source§

impl Eq for Stop

Source§

impl StructuralPartialEq for Stop

Auto Trait Implementations§

§

impl Freeze for Stop

§

impl RefUnwindSafe for Stop

§

impl Send for Stop

§

impl Sync for Stop

§

impl Unpin for Stop

§

impl UnsafeUnpin for Stop

§

impl UnwindSafe for Stop

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<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<'a, C, T> DynamicCtorThenBuilderHelper<'a, C> for T
where C: Match<'a>,

Source§

fn into_ctor_then_builder<F, O1, R>( self, func: F, ) -> DynamicCtorThenBuilder<C, T, F>
where F: Fn(&mut C, &O1) -> Result<R, Error>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedTy for T
where T: Any + Debug + Sync + Send + 'static,

Source§

impl<T> MayDebug for T