Enum nu_protocol::SyntaxShape

pub enum SyntaxShape {
    Any,
    String,
    ColumnPath,
    FullColumnPath,
    Number,
    Range,
    Int,
    FilePath,
    GlobPattern,
    Block,
    Table,
    Unit,
    Operator,
    RowCondition,
    MathExpression,
}

The syntactic shapes that values must match to be passed into a command. You can think of this as the type-checking that occurs when you call a function.

Variants

Any

Any syntactic form is allowed

String

Strings and string-like bare words are allowed

ColumnPath

A dotted path to navigate the table

FullColumnPath

A dotted path to navigate the table (including variable)

Number

Only a numeric (integer or decimal) value is allowed

Range

A range is allowed (eg, 1..3)

Int

Only an integer value is allowed

FilePath

A filepath is allowed

GlobPattern

A glob pattern is allowed, eg foo*

Block

A block is allowed, eg {start this thing}

Table

A table is allowed, eg [first second]

Unit

A unit value is allowed, eg 10kb

Operator

An operator

RowCondition

A math expression which expands shorthand forms on the lefthand side, eg foo > 1 The shorthand allows us to more easily reach columns inside of the row being passed in

MathExpression

A general math expression, eg the 1 + 2 of = 1 + 2

Trait Implementations

impl Clone for SyntaxShape

fn clone(&self) -> SyntaxShape

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SyntaxShape

impl Debug for SyntaxShape

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SyntaxShape

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

Deserialize this value from the given Serde deserializer.

impl Eq for SyntaxShape

impl Hash for SyntaxShape

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<SyntaxShape> for SyntaxShape

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PrettyDebug for SyntaxShape

fn pretty(&self) -> DebugDocBuilder

Prepare SyntaxShape for pretty-printing

pub fn to_doc(&self) -> DebugDoc

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

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

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

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

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

impl Serialize for SyntaxShape

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

Serialize this value into the given Serde serializer.

impl StructuralEq for SyntaxShape

impl StructuralPartialEq for SyntaxShape