pub enum SyntaxShape {
Show 16 variants Any, String, ColumnPath, FullColumnPath, Number, Range, Int, FilePath, GlobPattern, Block, Table, Filesize, Duration, Operator, RowCondition, MathExpression,
}
Expand description

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]

Filesize

A filesize value is allowed, eg 10kb

Duration

A duration value is allowed, eg 19day

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

Implementations

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Deserialize this value from the given Serde deserializer. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

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

This method tests for !=.

Prepare SyntaxShape for pretty-printing

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. Read more

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Compare self to key and return true if they are equal.

Performs the conversion.

Performs the conversion.

Converts a value into a Spanned value

Converts a value into a Spanned value, using an unknown Span

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.