Trait CallExt 

pub trait CallExt {
    // Required methods
    fn has_flag(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        flag_name: &str,
    ) -> Result<bool, ShellError>;
    fn get_flag<T: FromValue>(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        name: &str,
    ) -> Result<Option<T>, ShellError>;
    fn get_flag_span(&self, stack: &Stack, name: &str) -> Option<Span>;
    fn rest<T: FromValue>(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        starting_pos: usize,
    ) -> Result<Vec<T>, ShellError>;
    fn rest_preserving_spreads<T: FromValue>(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        starting_pos: usize,
    ) -> Result<Vec<(T, bool)>, ShellError>;
    fn opt<T: FromValue>(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        pos: usize,
    ) -> Result<Option<T>, ShellError>;
    fn opt_const<T: FromValue>(
        &self,
        working_set: &StateWorkingSet<'_>,
        pos: usize,
    ) -> Result<Option<T>, ShellError>;
    fn req<T: FromValue>(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        pos: usize,
    ) -> Result<T, ShellError>;
    fn req_parser_info<T: FromValue>(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        name: &str,
    ) -> Result<T, ShellError>;
    fn has_positional_args(&self, stack: &Stack, starting_pos: usize) -> bool;
}

Required Methods

fn has_flag( &self, engine_state: &EngineState, stack: &mut Stack, flag_name: &str, ) -> Result<bool, ShellError>

Check if a boolean flag is set (i.e. --bool or --bool=true)

fn get_flag<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, name: &str, ) -> Result<Option<T>, ShellError>

fn get_flag_span(&self, stack: &Stack, name: &str) -> Option<Span>

Efficiently get the span of a flag argument

fn rest<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, starting_pos: usize, ) -> Result<Vec<T>, ShellError>

fn rest_preserving_spreads<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, starting_pos: usize, ) -> Result<Vec<(T, bool)>, ShellError>

Returns the rest arguments starting at starting_pos, preserving whether each item was passed as a spread argument.

The tuple contains (value, is_spread). This differs from CallExt::rest(), which flattens spread arguments into a single list of values.

fn opt<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, pos: usize, ) -> Result<Option<T>, ShellError>

fn opt_const<T: FromValue>( &self, working_set: &StateWorkingSet<'_>, pos: usize, ) -> Result<Option<T>, ShellError>

fn req<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, pos: usize, ) -> Result<T, ShellError>

fn req_parser_info<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, name: &str, ) -> Result<T, ShellError>

fn has_positional_args(&self, stack: &Stack, starting_pos: usize) -> bool

True if the command has any positional or rest arguments, excluding before the given index.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl CallExt for Call

fn has_flag( &self, engine_state: &EngineState, stack: &mut Stack, flag_name: &str, ) -> Result<bool, ShellError>

fn get_flag<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, name: &str, ) -> Result<Option<T>, ShellError>

fn get_flag_span(&self, _stack: &Stack, name: &str) -> Option<Span>

fn rest<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, starting_pos: usize, ) -> Result<Vec<T>, ShellError>

fn rest_preserving_spreads<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, starting_pos: usize, ) -> Result<Vec<(T, bool)>, ShellError>

fn opt<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, pos: usize, ) -> Result<Option<T>, ShellError>

fn opt_const<T: FromValue>( &self, working_set: &StateWorkingSet<'_>, pos: usize, ) -> Result<Option<T>, ShellError>

fn req<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, pos: usize, ) -> Result<T, ShellError>

fn req_parser_info<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, name: &str, ) -> Result<T, ShellError>

fn has_positional_args(&self, _stack: &Stack, starting_pos: usize) -> bool

impl CallExt for Call<'_>

fn has_flag( &self, engine_state: &EngineState, stack: &mut Stack, flag_name: &str, ) -> Result<bool, ShellError>

fn get_flag<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, name: &str, ) -> Result<Option<T>, ShellError>

fn get_flag_span(&self, stack: &Stack, name: &str) -> Option<Span>

fn rest<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, starting_pos: usize, ) -> Result<Vec<T>, ShellError>

fn rest_preserving_spreads<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, starting_pos: usize, ) -> Result<Vec<(T, bool)>, ShellError>

fn opt<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, pos: usize, ) -> Result<Option<T>, ShellError>

fn opt_const<T: FromValue>( &self, working_set: &StateWorkingSet<'_>, pos: usize, ) -> Result<Option<T>, ShellError>

fn req<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, pos: usize, ) -> Result<T, ShellError>

fn req_parser_info<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, name: &str, ) -> Result<T, ShellError>

fn has_positional_args(&self, stack: &Stack, starting_pos: usize) -> bool

impl CallExt for Call

fn has_flag( &self, _engine_state: &EngineState, stack: &mut Stack, flag_name: &str, ) -> Result<bool, ShellError>

fn get_flag<T: FromValue>( &self, _engine_state: &EngineState, stack: &mut Stack, name: &str, ) -> Result<Option<T>, ShellError>

fn get_flag_span(&self, stack: &Stack, name: &str) -> Option<Span>

fn rest<T: FromValue>( &self, _engine_state: &EngineState, stack: &mut Stack, starting_pos: usize, ) -> Result<Vec<T>, ShellError>

fn rest_preserving_spreads<T: FromValue>( &self, _engine_state: &EngineState, stack: &mut Stack, starting_pos: usize, ) -> Result<Vec<(T, bool)>, ShellError>

fn opt<T: FromValue>( &self, _engine_state: &EngineState, stack: &mut Stack, pos: usize, ) -> Result<Option<T>, ShellError>

fn opt_const<T: FromValue>( &self, _working_set: &StateWorkingSet<'_>, _pos: usize, ) -> Result<Option<T>, ShellError>

fn req<T: FromValue>( &self, _engine_state: &EngineState, stack: &mut Stack, pos: usize, ) -> Result<T, ShellError>

fn req_parser_info<T: FromValue>( &self, engine_state: &EngineState, stack: &mut Stack, name: &str, ) -> Result<T, ShellError>

fn has_positional_args(&self, stack: &Stack, starting_pos: usize) -> bool

Implementors