Enum nu_protocol::value::UntaggedValue

pub enum UntaggedValue {
    Primitive(Primitive),
    Row(Dictionary),
    Table(Vec<Value>),
    Error(ShellError),
    Block(Box<CapturedBlock>),
}

The core structured values that flow through a pipeline

Variants

Primitive(Primitive)

A primitive (or fundamental) type of values

Row(Dictionary)

A table row

Table(Vec<Value>)

A full inner (or embedded) table

Error(ShellError)

An error value that represents an error that occurred as the values in the pipeline were built

Block(Box<CapturedBlock>)

A block of Nu code, eg { ls | get name ; echo "done" } with its captured values

Implementations

impl UntaggedValue

pub fn data_descriptors(&self) -> Vec<String>

Get the corresponding descriptors (column names) associated with this value

pub fn into_value(self, tag: impl Into<Tag>) -> Value

Convert this UntaggedValue to a Value with the given Tag

pub fn into_untagged_value(self) -> Value

Convert this UntaggedValue into a Value with an empty Tag

pub fn is_true(&self) -> bool

Returns true if this value represents boolean true

pub fn is_filesize(&self) -> bool

Returns true if this value represents a filesize

pub fn is_duration(&self) -> bool

Returns true if this value represents a duration

pub fn is_table(&self) -> bool

Returns true if this value represents a table

pub fn is_row(&self) -> bool

Returns true if this value represents a row

pub fn is_string(&self) -> bool

Returns true if this value represents a string

pub fn is_some(&self) -> bool

Returns true if the value represents something other than Nothing

pub fn is_none(&self) -> bool

Returns true if the value represents Nothing

pub fn is_error(&self) -> bool

Returns true if the value represents an error

pub fn expect_error(&self) -> ShellError

Expect this value to be an error and return it

pub fn expect_string(&self) -> &str

Expect this value to be a string and return it

pub fn expect_int(&self) -> i64

Expect this value to be an integer and return it

pub fn row(entries: IndexMap<String, Value>) -> UntaggedValue

Helper for creating row values

pub fn table(list: &[Value]) -> UntaggedValue

Helper for creating table values

pub fn string(s: impl Into<String>) -> UntaggedValue

Helper for creating string values

pub fn column_path(s: &str, span: Span) -> UntaggedValue

Helper for creating column-path values

pub fn int(i: impl Into<BigInt>) -> UntaggedValue

Helper for creating integer values

pub fn glob_pattern(s: impl Into<String>) -> UntaggedValue

Helper for creating glob pattern values

pub fn filepath(s: impl Into<PathBuf>) -> UntaggedValue

Helper for creating filepath values

pub fn filesize(s: impl Into<BigInt>) -> UntaggedValue

Helper for creating filesize values

pub fn decimal(s: impl Into<BigDecimal>) -> UntaggedValue

Helper for creating decimal values

pub fn decimal_from_float(f: f64, span: Span) -> UntaggedValue

Helper for creating decimal values

pub fn binary(binary: Vec<u8>) -> UntaggedValue

Helper for creating binary (non-text) buffer values

pub fn range(
    left: (Spanned<Primitive>, RangeInclusion),
    right: (Spanned<Primitive>, RangeInclusion)
) -> UntaggedValue

Helper for creating range values

pub fn boolean(b: impl Into<bool>) -> UntaggedValue

Helper for creating boolean values

pub fn duration(nanos: impl Into<BigInt>) -> UntaggedValue

Helper for creating date duration values

pub fn system_date(s: SystemTime) -> UntaggedValue

Helper for creating datatime values

pub fn date(d: impl Into<DateTime<FixedOffset>>) -> UntaggedValue

pub fn nothing() -> UntaggedValue

Helper for creating the Nothing value

Trait Implementations

impl Clone for UntaggedValue

fn clone(&self) -> UntaggedValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UntaggedValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UntaggedValue

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

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a Value> for &'a UntaggedValue

Convert a borrowed Value into a borrowed UntaggedValue

fn from(x: &'a Value) -> Self

Performs the conversion.

impl From<ShellError> for UntaggedValue

fn from(e: ShellError) -> Self

Performs the conversion.

impl<T> From<T> for UntaggedValue where
    T: Into<Primitive>, 

fn from(input: T) -> UntaggedValue

Convert a Primitive to an UntaggedValue

impl From<UntaggedValue> for Value

fn from(value: UntaggedValue) -> Value

Convert an UntaggedValue into a Value with a default tag

impl From<Value> for UntaggedValue

fn from(v: Value) -> UntaggedValue

Convert a Value into an UntaggedValue

impl Hash for UntaggedValue

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for UntaggedValue

fn cmp(&self, other: &UntaggedValue) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<UntaggedValue> for UntaggedValue

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

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

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

This method tests for !=.

impl PartialOrd<UntaggedValue> for UntaggedValue

fn partial_cmp(&self, other: &UntaggedValue) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for UntaggedValue

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

Serialize this value into the given Serde serializer.

impl ShellTypeName for UntaggedValue

fn type_name(&self) -> &'static str

Get the type name for the UntaggedValue

impl Eq for UntaggedValue

impl StructuralEq for UntaggedValue

impl StructuralPartialEq for UntaggedValue