Struct nu_protocol::value::Value

pub struct Value {
    pub value: UntaggedValue,
    pub tag: Tag,
}

The fundamental structured value that flows through the pipeline, with associated metadata

Fields

value: UntaggedValue

tag: Tag

Implementations

impl Value

pub fn new(untagged_value: UntaggedValue, the_tag: Tag) -> Self

Helper to create a Value

pub fn anchor(&self) -> Option<AnchorLocation>

Get the corresponding anchor (originating location) for the Value

pub fn anchor_name(&self) -> Option<String>

Get the name (url, filepath, etc) behind an anchor for the Value

pub fn tag(&self) -> Tag

Get the metadata for the Value

pub fn as_string(&self) -> Result<String, ShellError>

View the Value as a string, if possible

pub fn convert_to_string(&self) -> String

pub fn format(&self, fmt: &str) -> Result<String, ShellError>

pub fn as_forgiving_string(&self) -> Result<&str, ShellError>

View into the borrowed string contents of a Value, if possible

pub fn as_path(&self) -> Result<PathBuf, ShellError>

View the Value as a path, if possible

pub fn as_primitive(&self) -> Result<Primitive, ShellError>

View the Value as a Primitive value, if possible

pub fn is_primitive(&self) -> bool

View the Value as a Primitive value, if possible

pub fn as_u64(&self) -> Result<u64, ShellError>

View the Value as unsigned 64-bit, if possible

pub fn as_bool(&self) -> Result<bool, ShellError>

View the Value as boolean, if possible

pub fn table_entries(&self) -> TableValueIter<'_>

Returns an iterator of the values rows

pub fn row_entries(&self) -> RowValueIter<'_>

Returns an iterator of the value's cells

pub fn is_empty(&self) -> bool

Returns true if the value is empty

pub fn nothing() -> Value

Methods from Deref<Target = UntaggedValue>

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

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

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

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Deref for Value

Overload deferencing to give back the UntaggedValue inside of a Value

type Target = UntaggedValue

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Value

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

Deserialize this value from the given Serde deserializer.

impl Eq for Value

impl<'_> From<&'_ str> for Value

fn from(s: &str) -> Value

Performs the conversion.

impl From<String> for Value

fn from(s: String) -> Value

Performs the conversion.

impl From<TaggedDictBuilder> for Value

fn from(input: TaggedDictBuilder) -> Value

Convert a builder into a tagged Value

impl From<UntaggedValue> for Value

fn from(value: UntaggedValue) -> Value

Convert an UntaggedValue into a Value with a default tag

impl From<Value> for ReturnValue

fn from(v: Value) -> Self

Performs the conversion.

impl From<Value> for UntaggedValue

fn from(v: Value) -> UntaggedValue

Convert a Value into an UntaggedValue

impl From<bool> for Value

fn from(s: bool) -> Value

Performs the conversion.

impl HasSpan for Value

fn span(&self) -> Span

Return the corresponding Span for the Value

impl Hash for Value

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<'a> Into<&'a UntaggedValue> for &'a Value

Convert a borrowed Value into a borrowed UntaggedValue

fn into(self) -> &'a UntaggedValue

Performs the conversion.

impl Ord for Value

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

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

Restrict a value to a certain interval.

impl PartialEq<Value> for Dictionary

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

Test a dictionary against a Value for equality

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Value> for Value

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Value> for Value

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

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

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

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

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

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

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

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

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

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

impl<'_> PrettyDebug for &'_ Value

fn pretty(&self) -> DebugDocBuilder

Get a borrowed Value ready to be pretty-printed

fn to_doc(&self) -> DebugDoc

fn pretty_doc(
    &self
) -> Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>

fn pretty_builder(&self) -> DocBuilder<'static, BoxAllocator, ShellAnnotation>

fn display(&self) -> String

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.

fn plain_string(&self, width: usize) -> String

fn colored_string(&self, width: usize) -> String

impl PrettyDebug for Value

fn pretty(&self) -> DebugDocBuilder

Get a Value ready to be pretty-printed

fn to_doc(&self) -> DebugDoc

fn pretty_doc(
    &self
) -> Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>

fn pretty_builder(&self) -> DocBuilder<'static, BoxAllocator, ShellAnnotation>

fn display(&self) -> String

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.

fn plain_string(&self, width: usize) -> String

fn colored_string(&self, width: usize) -> String

impl Serialize for Value

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 Value

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

Get the type name for the Value

impl StructuralEq for Value

impl<'_> TryFrom<&'_ Value> for i64

type Error = ShellError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<i64, ShellError>

Convert to an i64 integer, if possible

impl<'_> TryFrom<&'_ Value> for String

type Error = ShellError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<String, ShellError>

Convert to a string, if possible

impl<'_> TryFrom<&'_ Value> for Vec<u8>

type Error = ShellError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Vec<u8>, ShellError>

Convert to a u8 vec, if possible

impl<'a> TryFrom<&'a Value> for &'a Dictionary

type Error = ShellError

The type returned in the event of a conversion error.

fn try_from(value: &'a Value) -> Result<&'a Dictionary, ShellError>

Convert to a dictionary, if possible