Enum nu_protocol::Value

pub enum Value {
    Bool {
        val: bool,
        span: Span,
    },
    Int {
        val: i64,
        span: Span,
    },
    Float {
        val: f64,
        span: Span,
    },
    Filesize {
        val: i64,
        span: Span,
    },
    Duration {
        val: i64,
        span: Span,
    },
    Date {
        val: DateTime<FixedOffset>,
        span: Span,
    },
    Range {
        val: Box<Range>,
        span: Span,
    },
    String {
        val: String,
        span: Span,
    },
    Record {
        cols: Vec<String>,
        vals: Vec<Value>,
        span: Span,
    },
    List {
        vals: Vec<Value>,
        span: Span,
    },
    Block {
        val: BlockId,
        captures: HashMap<VarId, Value>,
        span: Span,
    },
    Nothing {
        span: Span,
    },
    Error {
        error: ShellError,
    },
    Binary {
        val: Vec<u8>,
        span: Span,
    },
    CellPath {
        val: CellPath,
        span: Span,
    },
    CustomValue {
        val: Box<dyn CustomValue>,
        span: Span,
    },
}

Core structured values that pass through the pipeline in Nushell.

Variants

Bool

Fields

val: bool

span: Span

Int

Fields

val: i64

span: Span

Float

Fields

val: f64

span: Span

Filesize

Fields

val: i64

span: Span

Duration

Fields

val: i64

span: Span

Date

Fields

val: DateTime<FixedOffset>

span: Span

Range

Fields

val: Box<Range>

span: Span

String

Fields

val: String

span: Span

Record

Fields

cols: Vec<String>

vals: Vec<Value>

span: Span

List

Fields

vals: Vec<Value>

span: Span

Block

Fields

val: BlockId

captures: HashMap<VarId, Value>

span: Span

Nothing

Fields

span: Span

Error

Fields

error: ShellError

Binary

Fields

val: Vec<u8>

span: Span

CellPath

Fields

val: CellPath

span: Span

CustomValue

Fields

val: Box<dyn CustomValue>

span: Span

Implementations

impl Value

pub fn into_config(self) -> Result<Config, ShellError>

impl Value

pub fn as_f64(&self) -> Result<f64, ShellError>

pub fn as_i64(&self) -> Result<i64, ShellError>

impl Value

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

Converts into string values that can be changed into string natively

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

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

pub fn as_block(&self) -> Result<BlockId, ShellError>

pub fn as_binary(&self) -> Result<&[u8], ShellError>

pub fn as_record(&self) -> Result<(&[String], &[Value]), ShellError>

pub fn as_list(&self) -> Result<&[Value], ShellError>

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

pub fn as_float(&self) -> Result<f64, ShellError>

pub fn as_integer(&self) -> Result<i64, ShellError>

pub fn span(&self) -> Result<Span, ShellError>

Get the span for the current value

pub fn with_span(self, new_span: Span) -> Value

Update the value with a new span

pub fn get_type(&self) -> Type

Get the type of the current Value

pub fn get_data_by_key(&self, name: &str) -> Option<Value>

pub fn into_string(&self, separator: &str, config: &Config) -> String

Convert Value into string. Note that Streams will be consumed.

pub fn into_abbreviated_string(&self, config: &Config) -> String

Convert Value into string. Note that Streams will be consumed.

pub fn debug_value(&self) -> String

Convert Value into a debug string

pub fn debug_string(&self, separator: &str, config: &Config) -> String

Convert Value into string. Note that Streams will be consumed.

pub fn is_empty(&self) -> bool

Check if the content is empty

pub fn is_nothing(&self) -> bool

pub fn nothing(span: Span) -> Value

Create a new Nothing value

pub fn follow_cell_path(
    self,
    cell_path: &[PathMember],
    insensitive: bool
) -> Result<Value, ShellError>

Follow a given column path into the value: for example accessing select elements in a stream or list

pub fn follow_cell_path_not_from_user_input(
    self,
    cell_path: &[PathMember],
    insensitive: bool
) -> Result<Value, ShellError>

pub fn upsert_cell_path(
    &mut self,
    cell_path: &[PathMember],
    callback: Box<dyn FnOnce(&Value) -> Value>
) -> Result<(), ShellError>

Follow a given column path into the value: for example accessing select elements in a stream or list

pub fn upsert_data_at_cell_path(
    &mut self,
    cell_path: &[PathMember],
    new_val: Value
) -> Result<(), ShellError>

pub fn update_cell_path(
    &mut self,
    cell_path: &[PathMember],
    callback: Box<dyn FnOnce(&Value) -> Value>
) -> Result<(), ShellError>

Follow a given column path into the value: for example accessing select elements in a stream or list

pub fn update_data_at_cell_path(
    &mut self,
    cell_path: &[PathMember],
    new_val: Value
) -> Result<(), ShellError>

pub fn remove_data_at_cell_path(
    &mut self,
    cell_path: &[PathMember]
) -> Result<(), ShellError>

pub fn insert_data_at_cell_path(
    &mut self,
    cell_path: &[PathMember],
    new_val: Value
) -> Result<(), ShellError>

pub fn is_true(&self) -> bool

pub fn is_false(&self) -> bool

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

pub fn string(val: impl Into<String>, span: Span) -> Value

pub fn binary(val: impl Into<Vec<u8>>, span: Span) -> Value

pub fn int(val: i64, span: Span) -> Value

pub fn float(val: f64, span: Span) -> Value

pub fn boolean(val: bool, span: Span) -> Value

pub fn test_string(s: impl Into<String>) -> Value

Note: Only use this for test data, not live data, as it will point into unknown source when used in errors.

pub fn test_int(val: i64) -> Value

Note: Only use this for test data, not live data, as it will point into unknown source when used in errors.

pub fn test_float(val: f64) -> Value

Note: Only use this for test data, not live data, as it will point into unknown source when used in errors.

pub fn test_bool(val: bool) -> Value

Note: Only use this for test data, not live data, as it will point into unknown source when used in errors.

pub fn test_filesize(val: i64) -> Value

Note: Only use this for test data, not live data, as it will point into unknown source when used in errors.

pub fn test_nothing() -> Value

Note: Only use this for test data, not live data, as it will point into unknown source when used in errors.

pub fn test_record(cols: Vec<impl Into<String>>, vals: Vec<Value>) -> Value

Note: Only use this for test data, not live data, as it will point into unknown source when used in errors.

impl Value

pub fn add(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError>

pub fn append(
    &self,
    op: Span,
    rhs: &Value,
    span: Span
) -> Result<Value, ShellError>

pub fn sub(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError>

pub fn mul(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError>

pub fn div(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError>

pub fn floor_div(
    &self,
    op: Span,
    rhs: &Value,
    span: Span
) -> Result<Value, ShellError>

pub fn lt(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError>

pub fn lte(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError>

pub fn gt(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError>

pub fn gte(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError>

pub fn eq(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError>

pub fn ne(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError>

pub fn in(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError>

pub fn not_in(
    &self,
    op: Span,
    rhs: &Value,
    span: Span
) -> Result<Value, ShellError>

pub fn regex_match(
    &self,
    op: Span,
    rhs: &Value,
    invert: bool,
    span: Span
) -> Result<Value, ShellError>

pub fn starts_with(
    &self,
    op: Span,
    rhs: &Value,
    span: Span
) -> Result<Value, ShellError>

pub fn ends_with(
    &self,
    op: Span,
    rhs: &Value,
    span: Span
) -> Result<Value, ShellError>

pub fn bit_shl(
    &self,
    op: Span,
    rhs: &Value,
    span: Span
) -> Result<Value, ShellError>

pub fn bit_shr(
    &self,
    op: Span,
    rhs: &Value,
    span: Span
) -> Result<Value, ShellError>

pub fn bit_or(
    &self,
    op: Span,
    rhs: &Value,
    span: Span
) -> Result<Value, ShellError>

pub fn bit_xor(
    &self,
    op: Span,
    rhs: &Value,
    span: Span
) -> Result<Value, ShellError>

pub fn bit_and(
    &self,
    op: Span,
    rhs: &Value,
    span: Span
) -> Result<Value, ShellError>

pub fn modulo(
    &self,
    op: Span,
    rhs: &Value,
    span: Span
) -> Result<Value, ShellError>

pub fn and(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError>

pub fn or(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError>

pub fn pow(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError>

Trait Implementations

impl Clone for Value

fn clone(&self) -> Self

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 Default for Value

fn default() -> Self

Returns the “default value” for a type.

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 From<Spanned<HashMap<String, Value, RandomState>>> for Value

Create a Value::Record from a spanned hashmap

fn from(input: Spanned<HashMap<String, Value>>) -> Self

Converts to this type from the input type.

impl From<Spanned<IndexMap<String, Value, RandomState>>> for Value

Create a Value::Record from a spanned indexmap

fn from(input: Spanned<IndexMap<String, Value>>) -> Self

Converts to this type from the input type.

impl FromValue for Value

fn from_value(v: &Value) -> Result<Self, ShellError>

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 ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Value> for Value

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

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

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

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

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

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

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

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

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 Value

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

Serialize this value into the given Serde serializer.