Struct Signature 

pub struct Signature {

    pub name: String,
    pub description: String,
    pub extra_description: String,
    pub search_terms: Vec<String>,
    pub required_positional: Vec<PositionalArg>,
    pub optional_positional: Vec<PositionalArg>,
    pub rest_positional: Option<PositionalArg>,
    pub named: Vec<Flag>,
    pub input_output_types: Vec<(Type, Type)>,
    pub allow_variants_without_examples: bool,
    pub is_filter: bool,
    pub creates_scope: bool,
    pub allows_unknown_args: bool,
    pub category: Category,
}

Signature information of a Command

Fields

name: String

description: String

extra_description: String

search_terms: Vec<String>

required_positional: Vec<PositionalArg>

optional_positional: Vec<PositionalArg>

rest_positional: Option<PositionalArg>

named: Vec<Flag>

input_output_types: Vec<(Type, Type)>

allow_variants_without_examples: bool

is_filter: bool

creates_scope: bool

allows_unknown_args: bool

category: Category

Implementations

impl Signature

pub fn new(name: impl Into<String>) -> Signature

Creates a new signature for a command with name

pub fn get_input_type(&self) -> Type

Gets the input type from the signature

If the input was unspecified or the signature has several different input types, Type::Any is returned. Otherwise, if the signature has one or same input types, this type is returned.

pub fn get_output_type(&self) -> Type

Gets the output type from the signature

If the output was unspecified or the signature has several different input types, Type::Any is returned. Otherwise, if the signature has one or same output types, this type is returned.

pub fn add_help(self) -> Signature

Add a default help option to a signature

pub fn build(name: impl Into<String>) -> Signature

Build an internal signature with default help option

This is equivalent to Signature::new(name).add_help().

pub fn description(self, msg: impl Into<String>) -> Signature

Add a description to the signature

This should be a single sentence as it is the part shown for example in the completion menu.

pub fn extra_description(self, msg: impl Into<String>) -> Signature

Add an extra description to the signature.

Here additional documentation can be added

pub fn search_terms(self, terms: Vec<String>) -> Signature

Add search terms to the signature

pub fn update_from_command(self, command: &dyn Command) -> Signature

Update signature’s fields from a Command trait implementation

pub fn allows_unknown_args(self) -> Signature

Allow unknown signature parameters

pub fn required( self, name: impl Into<String>, shape: impl Into<SyntaxShape>, desc: impl Into<String>, ) -> Signature

Add a required positional argument to the signature

pub fn optional( self, name: impl Into<String>, shape: impl Into<SyntaxShape>, desc: impl Into<String>, ) -> Signature

Add an optional positional argument to the signature

pub fn rest( self, name: &str, shape: impl Into<SyntaxShape>, desc: impl Into<String>, ) -> Signature

Add a rest positional parameter

Rest positionals (also called rest parameters) are treated as optional: passing 0 arguments is a valid call. If the command requires at least one argument, it must be checked by the implementation.

pub fn operates_on_cell_paths(&self) -> bool

Is this command capable of operating on its input via cell paths?

pub fn named( self, name: impl Into<String>, shape: impl Into<SyntaxShape>, desc: impl Into<String>, short: Option<char>, ) -> Signature

Add an optional named flag argument to the signature

pub fn required_named( self, name: impl Into<String>, shape: impl Into<SyntaxShape>, desc: impl Into<String>, short: Option<char>, ) -> Signature

Add a required named flag argument to the signature

pub fn switch( self, name: impl Into<String>, desc: impl Into<String>, short: Option<char>, ) -> Signature

Add a switch to the signature

pub fn input_output_type(self, input_type: Type, output_type: Type) -> Signature

Changes the input type of the command signature

pub fn input_output_types( self, input_output_types: Vec<(Type, Type)>, ) -> Signature

Set the input-output type signature variants of the command

pub fn category(self, category: Category) -> Signature

Changes the signature category

pub fn creates_scope(self) -> Signature

Sets that signature will create a scope as it parses

pub fn allow_variants_without_examples(self, allow: bool) -> Signature

pub fn call_signature(&self) -> String

A string rendering of the command signature

If the command has flags, all of them will be shown together as {flags}.

pub fn get_shorts(&self) -> Vec<char>

Get list of the short-hand flags

pub fn get_names(&self) -> Vec<&str>

Get list of the long-hand flags

pub fn get_positional(&self, position: usize) -> Option<&PositionalArg>

Returns an argument with the index position

It will index, in order, required arguments, then optional, then the trailing ...rest argument.

pub fn num_positionals(&self) -> usize

Returns the number of (optional) positional parameters in a signature

This does not include the ...rest parameter, even if it’s present.

pub fn get_long_flag(&self, name: &str) -> Option<Flag>

Find the matching long flag

pub fn get_short_flag(&self, short: char) -> Option<Flag>

Find the matching long flag

pub fn filter(self) -> Signature

Set the filter flag for the signature

pub fn predeclare(self) -> Box<dyn Command>

Create a placeholder implementation of Command as a way to predeclare a definition’s signature so other definitions can see it. This placeholder is later replaced with the full definition in a second pass of the parser.

pub fn into_block_command( self, block_id: BlockId, attributes: Vec<(String, Value)>, examples: Vec<CustomExample>, ) -> Box<dyn Command>

Combines a signature and a block into a runnable block

Trait Implementations

impl Clone for Signature

fn clone(&self) -> Signature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Signature

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Signature

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Signature

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Signature

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Signature