Struct nu_engine::EvaluatedCommandArgs

pub struct EvaluatedCommandArgs {
    pub host: Arc<Mutex<dyn Host>>,
    pub ctrl_c: Arc<AtomicBool>,
    pub configs: Arc<Mutex<ConfigHolder>>,
    pub shell_manager: ShellManager,
    pub call_info: CallInfo,
    pub scope: Scope,
}

Fields

host: Arc<Mutex<dyn Host>>

ctrl_c: Arc<AtomicBool>

configs: Arc<Mutex<ConfigHolder>>

shell_manager: ShellManager

call_info: CallInfo

scope: Scope

Implementations

impl EvaluatedCommandArgs

pub fn new(
    host: Arc<Mutex<dyn Host>>,
    ctrl_c: Arc<AtomicBool>,
    configs: Arc<Mutex<ConfigHolder>>,
    shell_manager: ShellManager,
    call_info: CallInfo,
    scope: Scope
) -> Self

Constructs a new EvaluatedCommandArgs.

impl EvaluatedCommandArgs

pub fn nth(&self, pos: usize) -> Option<&Value>

pub fn expect_nth(&self, pos: usize) -> Result<&Value, ShellError>

Get the nth positional argument, error if not possible

pub fn get_flag<T: FromValue>(
    &self,
    name: &str
) -> Result<Option<T>, ShellError>

pub fn req_named<T: FromValue>(&self, name: &str) -> Result<T, ShellError>

pub fn has_flag(&self, name: &str) -> bool

pub fn req<T: FromValue>(&self, pos: usize) -> Result<T, ShellError>

pub fn opt<T: FromValue>(&self, pos: usize) -> Result<Option<T>, ShellError>

pub fn rest_args<T: FromValue>(&self) -> Result<Vec<T>, ShellError>

pub fn rest<T: FromValue>(
    &self,
    starting_pos: usize
) -> Result<Vec<T>, ShellError>

pub fn rest_with_minimum<T: FromValue>(
    &self,
    pos: usize,
    count: usize
) -> Result<Vec<T>, ShellError>