Struct Signature

pub struct Signature {

    pub name: String,
    pub usage: String,
    pub extra_usage: 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_type: Type,
    pub output_type: Type,
    pub is_filter: bool,
    pub creates_scope: bool,
    pub category: Category,
}

Fields

name: String

usage: String

extra_usage: String

search_terms: Vec<String>

required_positional: Vec<PositionalArg>

optional_positional: Vec<PositionalArg>

rest_positional: Option<PositionalArg>

named: Vec<Flag>

input_type: Type

output_type: Type

is_filter: bool

creates_scope: bool

category: Category

Implementations

impl Signature

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

pub fn add_help(self) -> Signature

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

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

Add a description to the signature

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

Add an extra description to the signature

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 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

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_type(self, input_type: Type) -> Signature

Changes the input type of the command signature

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

Changes the output type of the command signature

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 call_signature(&self) -> String

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>

pub fn num_positionals(&self) -> usize

pub fn num_positionals_after(&self, idx: usize) -> usize

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: usize) -> 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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Signature, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Signature

fn eq(&self, other: &Signature) -> 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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Signature