Enum nu_protocol::value::primitive::Primitive

pub enum Primitive {
    Nothing,
    Int(BigInt),
    Decimal(BigDecimal),
    Filesize(BigInt),
    String(String),
    ColumnPath(ColumnPath),
    GlobPattern(String),
    Boolean(bool),
    Date(DateTime<FixedOffset>),
    Duration(BigInt),
    Range(Box<Range>),
    FilePath(PathBuf),
    Binary(Vec<u8>),
    BeginningOfStream,
    EndOfStream,
}

The most fundamental of structured values in Nu are the Primitive values. These values represent types like integers, strings, booleans, dates, etc that are then used as the building blocks of more complex structures.

Primitives also include marker values BeginningOfStream and EndOfStream which denote a change of condition in the stream

Variants

Nothing

An empty value

Int(BigInt)

A “big int”, an integer with arbitrarily large size (aka not limited to 64-bit)

Decimal(BigDecimal)

A “big decimal”, an decimal number with arbitrarily large size (aka not limited to 64-bit)

Filesize(BigInt)

A count in the number of bytes, used as a filesize

String(String)

A string value

ColumnPath(ColumnPath)

A path to travel to reach a value in a table

GlobPattern(String)

A glob pattern, eg foo*

Boolean(bool)

A boolean value

Date(DateTime<FixedOffset>)

A date value

Duration(BigInt)

A count in the number of nanoseconds

Range(Box<Range>)

A range of values

FilePath(PathBuf)

A file path

Binary(Vec<u8>)

A vector of raw binary data

BeginningOfStream

Beginning of stream marker, a pseudo-value not intended for tables

EndOfStream

End of stream marker, a pseudo-value not intended for tables

Implementations

impl Primitive

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

Converts a primitive value to a char, if possible. Uses a span to build an error if the conversion isn’t possible.

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

Converts a primitive value to a u64, if possible. Uses a span to build an error if the conversion isn’t possible.

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

Converts a primitive value to a u64, if possible. Uses a span to build an error if the conversion isn’t possible.

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

Converts a primitive value to a i64, if possible. Uses a span to build an error if the conversion isn’t possible.

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

Converts a primitive value to a u32, if possible. Uses a span to build an error if the conversion isn’t possible.

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

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

pub fn into_chrono_duration(self, span: Span) -> Result<Duration, ShellError>

pub fn into_string(self, span: Span) -> Result<String, ShellError>

pub fn is_empty(&self) -> bool

Returns true if the value is empty

Trait Implementations

impl Clone for Primitive

fn clone(&self) -> Primitive

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Primitive

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Primitive

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

Deserialize this value from the given Serde deserializer.

impl Display for Primitive

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

Formats the value using the given formatter.

impl Eq for Primitive

impl From<&'_ str> for Primitive

fn from(s: &str) -> Primitive

Helper to convert from string slices to a primitive

impl From<BigDecimal> for Primitive

fn from(decimal: BigDecimal) -> Primitive

Helper to convert from decimals to a Primitive value

impl From<BigInt> for Primitive

fn from(int: BigInt) -> Primitive

Helper to convert from integers to a Primitive value

impl From<Duration> for Primitive

fn from(duration: Duration) -> Primitive

Performs the conversion.

impl From<String> for Primitive

fn from(s: String) -> Primitive

Helper to convert from Strings to a primitive

impl From<bool> for Primitive

fn from(b: bool) -> Primitive

Helper to convert from boolean to a primitive

impl From<f64> for Primitive

fn from(float: f64) -> Primitive

Helper to convert from 64-bit float to a Primitive value

impl Hash for Primitive

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

Feeds this value into the given Hasher.

pub 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 Primitive

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Primitive> for Primitive

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

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

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

This method tests for !=.

impl PartialOrd<Primitive> for Primitive

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

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

#[must_use]

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

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

#[must_use]

pub 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]

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

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

#[must_use]

pub 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 PrettyDebug for Primitive

fn pretty(&self) -> DebugDocBuilder

Get a Primitive value ready to be pretty-printed

pub fn to_doc(&self) -> DebugDoc

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

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

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

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

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

impl PrettyType for Primitive

fn pretty_type(&self) -> DebugDocBuilder

Find the type of the Value and prepare it for pretty-printing

impl Serialize for Primitive

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 Primitive

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

Get the name of the type of a Primitive value

impl StructuralEq for Primitive

impl StructuralPartialEq for Primitive