Enum libhaystack::haystack::val::value::Value

pub enum Value {
    Null,
    Remove,
    Marker,
    Bool(Bool),
    Na,
    Number(Number),
    Str(Str),
    Uri(Uri),
    Ref(Ref),
    Symbol(Symbol),
    Date(Date),
    Time(Time),
    DateTime(DateTime),
    Coord(Coord),
    XStr(XStr),
    List(List),
    Dict(Dict),
    Grid(Grid),
}

The Value object is the universal type that can have any of supported tag values specified by the Project Haystack 4.0 spec.

It is implemented as an Algebraic type (enum) than can be constructed from build-in types, such as bool or i32, and dedicated Haystack types such as Str

Usage

Creating a scalar Haystack number value

use libhaystack::val::*;
use libhaystack::units::get_unit_or_default;

let num = Value::make_number_unit(42.0, get_unit_or_default("°F"));

assert!(num.is_number());
assert_eq!(Number::try_from(&num).unwrap().unit, Some(get_unit_or_default("°F")));

Creating complex structures such as a Dict

use libhaystack::dict;
use libhaystack::val::*;

let dict = Value::make_dict(dict!("strTagName" => Value::from("Str Tag value"),
                 "marker" => Value::make_marker()));
assert!(dict.is_dict());

Creating a Haystack Grid

use libhaystack::dict;
use libhaystack::val::*;

let grid = Value::make_grid_from_dicts(vec![
    dict!("dis" => Value::from("First dict row"),
          "id" => Value::make_ref_gen()),
    dict!("dis" => Value::from("Second dict row"),
          "id" => Value::make_ref_gen())
]);
assert!(grid.is_grid());
assert_eq!(Grid::try_from(&grid).unwrap().len(), 2);

Variants

Null

No value

Remove

A remove tag

Marker

Marker tag

Bool(Bool)

Bool true/false

Na

Na tag

Number(Number)

Number floating point value and optional unit

Str(Str)

Uri(Uri)

URI with string value

Ref(Ref)

Ref with string value

Symbol(Symbol)

A symbol with string value

Date(Date)

Date year, month, date

Time(Time)

Time hour, minutes, seconds with optional millis

DateTime(DateTime)

DateTime date, time and timezone

Coord(Coord)

Coordinate latitude and longitude

XStr(XStr)

XStr with type and value

List(List)

List of tags

Dict(Dict)

Dictionary of String key and Value values

Grid(Grid)

Haystack Grid

Implementations

impl Value

Implements the utility functions for creating and getting the current type

pub fn is_null(&self) -> bool

True if this Value is a haystack Null

pub fn has_value(&self) -> bool

True if this Haystack Value is not null

pub fn make_remove() -> Value

Construct a Remove Value

pub fn is_remove(&self) -> bool

True if this Value is a haystack Remove

pub fn make_marker() -> Value

Construct a Marker Value

pub fn is_marker(&self) -> bool

True if this Value is a haystack Marker

pub fn make_bool(value: bool) -> Value

Construct a Bool Value

pub fn make_true() -> Value

Construct a Bool ‘true’ Value

pub fn is_true(&self) -> bool

True if Value is a true (Bool)crate::val::Bool

pub fn is_false(&self) -> bool

True if Value is a false (Bool)crate::val::Bool

pub fn make_false() -> Value

Construct a Bool ‘false’ Value

pub fn is_bool(&self) -> bool

pub fn make_na() -> Value

Construct a Na Value

pub fn is_na(&self) -> bool

True if this Value is a haystack Na

pub fn make_number(value: f64) -> Value

Construct a Number Value from a floating point value

pub fn make_int(value: i64) -> Value

Construct a Number Value from a integer value

pub fn make_number_unit(value: f64, unit: &'static Unit) -> Value

Construct a Number Value with an unit

pub fn is_number(&self) -> bool

True if this Value is a haystack Number

pub fn make_str(value: &str) -> Value

Construct a Str Value from a string

pub fn is_str(&self) -> bool

True if this Value is a haystack Str

pub fn make_ref(value: &str) -> Value

Construct a Ref Value from a string

pub fn make_ref_gen() -> Value

Construct a Ref Value by generating an unique Ref

pub fn make_ref_with_dis(value: &str, dis: &str) -> Value

Construct a Ref Value from a string with a display name

pub fn is_ref(&self) -> bool

True if this Value is a haystack Ref

pub fn make_symbol(value: &str) -> Value

Construct a Symbol Value from a string

pub fn is_symbol(&self) -> bool

True if this Value is a haystack Symbol

pub fn make_uri(value: &str) -> Value

Construct a Uri Value from a string

pub fn is_uri(&self) -> bool

True if this Value is a haystack Uri

pub fn make_date(value: Date) -> Value

Construct a Date Value from a Date

pub fn is_date(&self) -> bool

True if this Value is a haystack Date

pub fn make_time(value: Time) -> Value

Construct a Time Value from a Time

pub fn is_time(&self) -> bool

True if this Value is a haystack Time

pub fn make_datetime(value: DateTime) -> Value

Construct a DateTime Value from a DateTime

pub fn make_datetime_from_iso(value: &str) -> Result<Value, String>

Try to construct a DateTime Value from a string

pub fn is_datetime(&self) -> bool

True if this Value is a haystack DateTime

pub fn make_coord(value: Coord) -> Value

Construct a Coord Value from a Coord

pub fn make_coord_from(lat: f64, long: f64) -> Value

Construct a Coord Value from a latitude and longitude

pub fn is_coord(&self) -> bool

True if this Value is a haystack Coord

pub fn make_xstr(value: XStr) -> Value

Construct a XStr Value from a XStr

pub fn make_xstr_from(typ: &str, value: &str) -> Value

Construct a XStr Value from a type and value

pub fn is_xstr(&self) -> bool

True if this Value is a haystack XStr

pub fn make_list(value: List) -> Value

Construct a List Value from a List

pub fn is_list(&self) -> bool

True if this Value is a haystack List

pub fn make_dict(value: Dict) -> Value

Construct a Dict Value from a Dict

pub fn is_dict(&self) -> bool

True if this Value is a haystack Dict

pub fn make_grid(value: Grid) -> Value

Construct a Grid Value from a Grid

pub fn make_grid_from_dicts(value: Vec<Dict>) -> Value

Construct a Grid Value from a list of Dicts

pub fn is_grid(&self) -> bool

True if this Value is a haystack `Dict

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

Implements the Default trait for the Value

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HVal

Hayson deserializer

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<HVal, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Value

Implement user friendly display for a Value

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

Formats the value using the given formatter.

impl From<&'_ Value> for HaystackKind

fn from(value: &Value) -> Self

Performs the conversion.

impl From<&'_ str> for Value

Converts from &str slice to a Str Value

fn from(value: &str) -> Self

Performs the conversion.

impl From<BTreeMap<String, Value>> for Value

Converts from DictType to a Dict Value

fn from(from: DictType) -> Self

Performs the conversion.

impl From<Bool> for Value

Converts from Bool to a Bool Value

fn from(value: Bool) -> Self

Performs the conversion.

impl From<Coord> for Value

Converts from Coord to a Coord Value

fn from(value: Coord) -> Self

Performs the conversion.

impl From<Date> for Value

Converts from Date to a Date Value

fn from(value: Date) -> Self

Performs the conversion.

impl From<DateTime<Utc>> for Value

Converts from DateTimeImpl<Utc> to a DateTime Value

fn from(from: DateTimeImpl<Utc>) -> Self

Performs the conversion.

impl From<DateTime> for Value

Converts from DateTime to a DateTime Value

fn from(value: DateTime) -> Self

Performs the conversion.

impl From<Dict> for Value

Converts from Dict to a Dict Value

fn from(value: Dict) -> Self

Performs the conversion.

impl From<Grid> for Value

Converts from Grid to a Grid Value

fn from(value: Grid) -> Self

Performs the conversion.

impl From<Marker> for Value

Converts from Marker to a Marker Value

fn from(_: Marker) -> Self

Performs the conversion.

impl From<Na> for Value

Converts from Na to a Na Value

fn from(_: Na) -> Self

Performs the conversion.

impl From<Number> for Value

Converts from Number to a Number Value

fn from(value: Number) -> Self

Performs the conversion.

impl From<Ref> for Value

Converts from Ref to a Ref Value

fn from(value: Ref) -> Self

Performs the conversion.

impl From<Remove> for Value

Converts from Remove to a Remove Value

fn from(_: Remove) -> Self

Performs the conversion.

impl From<Str> for Value

Converts from Str to a Str Value

fn from(value: Str) -> Self

Performs the conversion.

impl From<Symbol> for Value

Converts from Symbol to a Symbol Value

fn from(value: Symbol) -> Self

Performs the conversion.

impl From<Time> for Value

Converts from Time to a Time Value

fn from(value: Time) -> Self

Performs the conversion.

impl From<Uri> for Value

Converts from Uri to a Uri Value

fn from(value: Uri) -> Self

Performs the conversion.

impl From<Vec<Value, Global>> for Value

Converts from List to a List Value

fn from(value: List) -> Self

Performs the conversion.

impl From<XStr> for Value

Converts from XStr to a XStr Value

fn from(value: XStr) -> Self

Performs the conversion.

impl From<bool> for Value

Converts from bool to a Bool Value

fn from(value: bool) -> Self

Performs the conversion.

impl From<f64> for Value

Converts from f64 to a Number Value

fn from(value: f64) -> Self

Performs the conversion.

impl From<i32> for Value

Converts from i32 to a Number Value

fn from(value: i32) -> Self

Performs the conversion.

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

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

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: &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 HVal

Serializes a haystack value to Haystack JSON (Hayson)

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl ToZinc for Value

Implement the Zinc encoding for Haystack Value type

fn to_zinc<W: Write>(&self, writer: &mut W) -> Result<()>

fn to_zinc_string(&self) -> Result<String>

Encodes this Haystack type as a Zinc string

impl TryFrom<&'_ Value> for bool

Tries to convert from Bool Value to a bool

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Bool

Tries to convert from Bool Value to a Bool

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for f64

Tries to convert from Number Value to a f64

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Number

Tries to convert from Number Value to a Number

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Ref

Tries to convert from Value to a Ref

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Remove

Tries to convert from Remove Value to a Remove

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for String

Tries to convert from Str Value to a String

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Str

Tries to convert from Str Value to a Str

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Symbol

Tries to convert from Value to a Symbol

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Time

Tries to convert from Value to a Time

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Uri

Tries to convert from Value to a Uri

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for XStr

Tries to convert from Value to a XStr

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Coord

Tries to convert from Value to a Coord

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Date

Tries to convert from Value to a Date

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for DateTime

Tries to convert from Value to a DateTime

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Dict

Tries to convert from Value to a Dict

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Grid

Tries to convert from Value to a Grid

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for List

Tries to convert from Value to a List

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Marker

Tries to convert from Marker Value to a Marker

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Na

Tries to convert from Na Value to a Na

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Value

impl StructuralEq for Value