Enum nu_protocol::PositionalType

pub enum PositionalType {
    Mandatory(String, SyntaxShape),
    Optional(String, SyntaxShape),
}

The type of positional arguments

Variants

Mandatory(String, SyntaxShape)

A mandatory positional argument with the expected shape of the value

Optional(String, SyntaxShape)

An optional positional argument with the expected shape of the value

Implementations

impl PositionalType

pub fn mandatory(name: &str, ty: SyntaxShape) -> PositionalType

Helper to create a mandatory positional argument type

pub fn mandatory_any(name: &str) -> PositionalType

Helper to create a mandatory positional argument with an "any" type

pub fn mandatory_block(name: &str) -> PositionalType

Helper to create a mandatory positional argument with a block type

pub fn optional(name: &str, ty: SyntaxShape) -> PositionalType

Helper to create a optional positional argument type

pub fn optional_any(name: &str) -> PositionalType

Helper to create a optional positional argument with an "any" type

pub fn name(&self) -> &str

Gets the name of the positional argument

pub fn syntax_type(&self) -> SyntaxShape

Gets the expected type of a positional argument

Trait Implementations

impl Clone for PositionalType

fn clone(&self) -> PositionalType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PositionalType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PositionalType

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

Deserialize this value from the given Serde deserializer.

impl PrettyDebug for PositionalType

fn pretty(&self) -> DebugDocBuilder

Prepare the PositionalType for pretty-printing

fn to_doc(&self) -> DebugDoc

fn pretty_doc(
    &self
) -> Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>

fn pretty_builder(&self) -> DocBuilder<'static, BoxAllocator, ShellAnnotation>

fn display(&self) -> String

A convenience method that prints out the document without colors in 70 columns. Generally, you should use plain_string or colored_string if possible, but display() can be useful for trace lines and things like that, where you don't have control over the terminal.

fn plain_string(&self, width: usize) -> String

fn colored_string(&self, width: usize) -> String

impl Serialize for PositionalType

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

Serialize this value into the given Serde serializer.