Struct Call

pub struct Call {
    pub decl_id: DeclId,
    pub head: Span,
    pub span: Span,
    pub args_base: usize,
    pub args_len: usize,
}

Contains the information for a call being made to a declared command.

Fields

decl_id: DeclId

The declaration ID of the command to be invoked.

head: Span

The span encompassing the command name, before the arguments.

span: Span

The span encompassing the command name and all arguments.

args_base: usize

The base index of the arguments for this call within the argument stack.

args_len: usize

The number of Arguments for the call. Note that this just counts the number of Argument entries on the stack, and has nothing to do with the actual number of positional or spread arguments.

Implementations

impl Call

pub fn build(decl_id: DeclId, head: Span) -> CallBuilder

Build a new call with arguments.

pub fn arguments<'a>(&self, stack: &'a Stack) -> &'a [Argument]

Get the arguments for this call from the arguments stack.

pub fn arguments_span(&self) -> Span

The span encompassing the arguments

If there are no arguments the span covers where the first argument would exist

If there are one or more arguments the span encompasses the start of the first argument to end of the last argument

pub fn named_len(&self, stack: &Stack) -> usize

The number of named arguments, with or without values.

pub fn named_iter<'a>( &'a self, stack: &'a Stack, ) -> impl Iterator<Item = (Spanned<&'a str>, Option<&'a Value>)> + 'a

Iterate through named arguments, with or without values.

pub fn get_named_arg<'a>( &self, stack: &'a Stack, flag_name: &str, ) -> Option<&'a Value>

Get a named argument’s value by name. Returns None for named arguments with no value as well.

pub fn positional_len(&self, stack: &Stack) -> usize

The number of positional arguments, excluding spread arguments.

pub fn positional_iter<'a>( &self, stack: &'a Stack, ) -> impl Iterator<Item = &'a Value>

Iterate through positional arguments. Does not include spread arguments.

pub fn positional_nth<'a>( &self, stack: &'a Stack, index: usize, ) -> Option<&'a Value>

Get a positional argument by index. Does not include spread arguments.

pub fn positional_ast<'a>( &self, stack: &'a Stack, index: usize, ) -> Option<&'a Arc<Expression>>

Get the AST node for a positional argument by index. Not usually available unless the decl required it.

pub fn rest_iter<'a>( &self, stack: &'a Stack, start: usize, ) -> impl Iterator<Item = (&'a Value, bool)> + 'a

Returns every argument to the rest parameter, as well as whether each argument is spread or a normal positional argument (true for spread, false for normal)

pub fn rest_iter_flattened( &self, stack: &Stack, start: usize, ) -> Result<Vec<Value>, ShellError>

Returns all of the positional arguments including and after start, with spread arguments flattened into a single Vec.

pub fn get_parser_info<'a>( &self, stack: &'a Stack, name: &str, ) -> Option<&'a Expression>

Get a parser info argument by name.

pub fn span(&self) -> Span

Returns a span encompassing the entire call.

pub fn leave(&self, stack: &mut Stack)

Resets the Stack to its state before the call was made.

Trait Implementations

impl Clone for Call

fn clone(&self) -> Call

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Call

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

Formats the value using the given formatter.

impl<'a> From<&'a Call> for Call<'a>

fn from(call: &'a Call) -> Self

Converts to this type from the input type.