Enum nu_protocol::SyntaxShape [−][src]
pub enum SyntaxShape {}Show variants
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 syntactic form is allowed
Strings and string-like bare words are allowed
A dotted path to navigate the table
A dotted path to navigate the table (including variable)
Only a numeric (integer or decimal) value is allowed
A range is allowed (eg, 1..3
)
Only an integer value is allowed
A filepath is allowed
A glob pattern is allowed, eg foo*
A block is allowed, eg {start this thing}
A table is allowed, eg [first second]
A unit value is allowed, eg 10kb
An operator
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
A general math expression, eg the 1 + 2
of = 1 + 2
Trait Implementations
impl Clone for SyntaxShape
[src]
fn clone(&self) -> SyntaxShape
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Copy for SyntaxShape
[src]
impl Debug for SyntaxShape
[src]
impl<'de> Deserialize<'de> for SyntaxShape
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Eq for SyntaxShape
[src]
impl Hash for SyntaxShape
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl PartialEq<SyntaxShape> for SyntaxShape
[src]
fn eq(&self, other: &SyntaxShape) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PrettyDebug for SyntaxShape
[src]
fn pretty(&self) -> DebugDocBuilder
[src]
Prepare SyntaxShape for pretty-printing
pub fn to_doc(&self) -> DebugDoc
[src]
pub fn pretty_doc(
&self
) -> Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>
[src]
&self
) -> Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>
pub fn pretty_builder(
&self
) -> DocBuilder<'static, BoxAllocator, ShellAnnotation>
[src]
&self
) -> DocBuilder<'static, BoxAllocator, ShellAnnotation>
pub fn display(&self) -> String
[src]
pub fn plain_string(&self, width: usize) -> String
[src]
pub fn colored_string(&self, width: usize) -> String
[src]
impl Serialize for SyntaxShape
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralEq for SyntaxShape
[src]
impl StructuralPartialEq for SyntaxShape
[src]
Auto Trait Implementations
impl RefUnwindSafe for SyntaxShape
impl Send for SyntaxShape
impl Sync for SyntaxShape
impl Unpin for SyntaxShape
impl UnwindSafe for SyntaxShape
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
pub fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> PrettyDebugWithSource for T where
T: PrettyDebug,
[src]
T: PrettyDebug,
pub fn pretty_debug(&self, _source: &str) -> DebugDocBuilder
[src]
pub fn refined_pretty_debug(
&self,
_refine: PrettyDebugRefineKind,
source: &str
) -> DebugDocBuilder
[src]
&self,
_refine: PrettyDebugRefineKind,
source: &str
) -> DebugDocBuilder
pub fn debug(&self, source: impl Into<Text>) -> String where
Self: Clone,
[src]
Self: Clone,
pub fn debuggable(self, source: impl Into<Text>) -> DebuggableWithSource<Self>
[src]
impl<T> SpannedItem for T
[src]
pub fn spanned(self, span: impl Into<Span>) -> Spanned<Self>
[src]
pub fn spanned_unknown(self) -> Spanned<Self>
[src]
impl<T> TaggedItem for T
[src]
pub fn tagged(self, tag: impl Into<Tag>) -> Tagged<Self>
[src]
pub fn tagged_unknown(self) -> Tagged<Self>
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,