Enum nu_protocol::SyntaxShape

pub enum SyntaxShape {
    Any,
    Binary,
    Block,
    Boolean,
    CellPath,
    Closure(Option<Vec<SyntaxShape>>),
    Custom(Box<SyntaxShape>, DeclId),
    DateTime,
    Directory,
    Duration,
    Error,
    Expression,
    Filepath,
    Filesize,
    FullCellPath,
    GlobPattern,
    Int,
    ImportPattern,
    Keyword(Vec<u8>, Box<SyntaxShape>),
    List(Box<SyntaxShape>),
    MathExpression,
    Nothing,
    Number,
    OneOf(Vec<SyntaxShape>),
    Operator,
    Range,
    Record,
    RowCondition,
    Signature,
    String,
    Table,
    Variable,
    VarWithOptType,
}

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

Binary

A binary literal

Block

A block is allowed, eg {start this thing}

Boolean

A boolean value, eg true or false

CellPath

A dotted path to navigate the table

Closure(Option<Vec<SyntaxShape>>)

A closure is allowed, eg {|| start this thing}

Custom(Box<SyntaxShape>, DeclId)

A custom shape with custom completion logic

DateTime

A datetime value, eg 2022-02-02 or 2019-10-12T07:20:50.52+00:00

Directory

A directory is allowed

Duration

A duration value is allowed, eg 19day

Error

An error value

Expression

A general expression, eg 1 + 2 or foo --bar

Filepath

A filepath is allowed

Filesize

A filesize value is allowed, eg 10kb

FullCellPath

A dotted path to navigate the table (including variable)

GlobPattern

A glob pattern is allowed, eg foo*

Int

Only an integer value is allowed

ImportPattern

A module path pattern used for imports

Keyword(Vec<u8>, Box<SyntaxShape>)

A specific match to a word or symbol

List(Box<SyntaxShape>)

A list is allowed, eg [first second]

MathExpression

A general math expression, eg 1 + 2

Nothing

Nothing

Number

Only a numeric (integer or decimal) value is allowed

OneOf(Vec<SyntaxShape>)

One of a list of possible items, checked in order

Operator

An operator, eg +

Range

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

Record

A record value, eg {x: 1, y: 2}

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

Signature

A signature for a definition, [x:int, --foo]

String

Strings and string-like bare words are allowed

Table

A table is allowed, eg [[first, second]; [1, 2]]

Variable

A variable name, eg $foo

VarWithOptType

A variable with optional type, x or x: int

Implementations

impl SyntaxShape

pub fn to_type(&self) -> Type

Trait Implementations

impl Clone for SyntaxShape

fn clone(&self) -> SyntaxShape

Returns a copy of the value.

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

Performs copy-assignment from source.

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 Display for SyntaxShape

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

Formats the value using the given formatter.

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

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

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

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 Eq for SyntaxShape

impl StructuralEq for SyntaxShape

impl StructuralPartialEq for SyntaxShape