Struct nu_protocol::PluginSignature

pub struct PluginSignature {
    pub sig: Signature,
    pub examples: Vec<PluginExample>,
}

A simple wrapper for Signature that includes examples.

Fields

sig: Signature

examples: Vec<PluginExample>

Implementations

impl PluginSignature

pub fn new(sig: Signature, examples: Vec<PluginExample>) -> Self

pub fn add_help(self) -> PluginSignature

Add a default help option to a signature

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

Build an internal signature with default help option

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

Add a description to the signature

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

Add an extra description to the signature

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

Add search terms to the signature

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

Update signature’s fields from a Command trait implementation

pub fn allows_unknown_args(self) -> PluginSignature

Allow unknown signature parameters

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

Add a required positional argument to the signature

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

Add an optional positional argument to the signature

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

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

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

Add a required named flag argument to the signature

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

Add a switch to the signature

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

Changes the input type of the command signature

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

Set the input-output type signature variants of the command

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

Changes the signature category

pub fn creates_scope(self) -> PluginSignature

Sets that signature will create a scope as it parses

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

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

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) -> Box<dyn Command>

Combines a signature and a block into a runnable block

pub fn formatted_flags(self) -> String

pub fn plugin_examples(self, examples: Vec<PluginExample>) -> PluginSignature

Trait Implementations

impl Clone for PluginSignature

fn clone(&self) -> PluginSignature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PluginSignature

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginSignature

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PluginSignature

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

where __S: Serializer,

Serialize this value into the given Serde serializer.