Enum SyntaxShape

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

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

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

A specific match to a word or symbol

Any

Any syntactic form is allowed

String

Strings and string-like bare words are allowed

CellPath

A dotted path to navigate the table

FullCellPath

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

Directory

A directory is allowed

GlobPattern

A glob pattern is allowed, eg foo*

ImportPattern

A module path pattern used for imports

Binary

A binary literal

Block(Option<Vec<SyntaxShape>>)

A block is allowed, eg {start this thing}

Table

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

List(Box<SyntaxShape>)

A table is allowed, eg [first second]

Filesize

A filesize value is allowed, eg 10kb

Duration

A duration value is allowed, eg 19day

DateTime

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

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 1 + 2

Variable

A variable name

VarWithOptType

A variable with optional type, x or x: int

Signature

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

Expression

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

Boolean

A boolean value

Record

A record value

Error

An error value

Custom(Box<SyntaxShape>, usize)

A custom shape with custom completion logic

Implementations

impl SyntaxShape

pub fn to_type(&self) -> Type

Trait Implementations

impl Clone for SyntaxShape

fn clone(&self) -> SyntaxShape

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SyntaxShape

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

Formats the value using the given formatter.

impl PartialEq for SyntaxShape

fn eq(&self, other: &SyntaxShape) -> 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 SyntaxShape

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 SyntaxShape

impl StructuralPartialEq for SyntaxShape