Skip to main content

CliOutcome

Enum CliOutcome 

Source
pub enum CliOutcome<Value, Error> {
    Success(Value),
    Failure(Error),
}
Expand description

States what a command answers: its value, or a failure that ends with a nonzero status.

A successful command exits with status zero. How a value or failure is rendered, and on which stream, is the interpreter’s choice.

Variants§

§

Success(Value)

The command succeeded with this value.

§

Failure(Error)

The command failed with this error.

Implementations§

Source§

impl<Value, Error> CliOutcome<Value, Error>
where Error: CliFailureAlg,

Source

pub fn cli_status(&self) -> u8

Returns the status the command exits with: zero on success, the failure’s own otherwise.

Trait Implementations§

Source§

impl<Value: Clone, Error: Clone> Clone for CliOutcome<Value, Error>

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<Value: Debug, Error: Debug> Debug for CliOutcome<Value, Error>

Source§

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

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

impl<Value: Eq, Error: Eq> Eq for CliOutcome<Value, Error>

Source§

impl<Value: PartialEq, Error: PartialEq> PartialEq for CliOutcome<Value, Error>

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<Value: PartialEq, Error: PartialEq> StructuralPartialEq for CliOutcome<Value, Error>

Auto Trait Implementations§

§

impl<Value, Error> Freeze for CliOutcome<Value, Error>
where Value: Freeze, Error: Freeze,

§

impl<Value, Error> RefUnwindSafe for CliOutcome<Value, Error>
where Value: RefUnwindSafe, Error: RefUnwindSafe,

§

impl<Value, Error> Send for CliOutcome<Value, Error>
where Value: Send, Error: Send,

§

impl<Value, Error> Sync for CliOutcome<Value, Error>
where Value: Sync, Error: Sync,

§

impl<Value, Error> Unpin for CliOutcome<Value, Error>
where Value: Unpin, Error: Unpin,

§

impl<Value, Error> UnsafeUnpin for CliOutcome<Value, Error>
where Value: UnsafeUnpin, Error: UnsafeUnpin,

§

impl<Value, Error> UnwindSafe for CliOutcome<Value, Error>
where Value: UnwindSafe, Error: UnwindSafe,

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.