Trait Command

Source

pub trait Command:
    Send
    + Sync
    + CommandClone {
Show 22 methods    // Required methods
    fn name(&self) -> &str;
    fn signature(&self) -> Signature;
    fn description(&self) -> &str;
    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call<'_>,
        input: PipelineData,
    ) -> Result<PipelineData, ShellError>;

    // Provided methods
    fn extra_description(&self) -> &str { ... }
    fn run_const(
        &self,
        working_set: &StateWorkingSet<'_>,
        call: &Call<'_>,
        input: PipelineData,
    ) -> Result<PipelineData, ShellError> { ... }
    fn examples(&self) -> Vec<Example<'_>> { ... }
    fn search_terms(&self) -> Vec<&str> { ... }
    fn is_const(&self) -> bool { ... }
    fn is_sub(&self) -> bool { ... }
    fn block_id(&self) -> Option<Id<Block>> { ... }
    fn as_alias(&self) -> Option<&Alias> { ... }
    fn plugin_identity(&self) -> Option<&PluginIdentity> { ... }
    fn command_type(&self) -> CommandType { ... }
    fn is_builtin(&self) -> bool { ... }
    fn is_custom(&self) -> bool { ... }
    fn is_keyword(&self) -> bool { ... }
    fn is_known_external(&self) -> bool { ... }
    fn is_alias(&self) -> bool { ... }
    fn is_plugin(&self) -> bool { ... }
    fn pipe_redirection(&self) -> (Option<OutDest>, Option<OutDest>) { ... }
    fn requires_ast_for_arguments(&self) -> bool { ... }
}