libhaystack 3.1.4

Rust implementation of the Haystack 4 data types, defs, filter, units, and encodings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

// Copyright (C) 2020 - 2022, J2 Innovations

//! Haystack Symbol

use std::fmt;

use crate::haystack::val::Value;

/// Haystack `Symbol`
///
/// # Example
/// Create `Symbol` value
/// ```
/// use libhaystack::val::*;
///
/// // Create `Symbol` from `&str` primitive
/// let sym_value = Value::from(Symbol::from("symbol"));
/// assert!(sym_value.is_symbol());
///
/// // Get the symbol value from the Value
/// assert_eq!(Symbol::try_from(&sym_value).unwrap(), Symbol::from("symbol"));
/// ```
#[derive(PartialEq, PartialOrd, Eq, Ord, Hash, Clone, Debug, Default)]
pub struct Symbol {
    pub value: String,
}

impl Symbol {
    /// Make a [Symbol](crate::val::Symbol) from a `&str`
    pub fn make(val: &str) -> Self {
        Symbol { value: val.into() }
    }
}

// Make a Haystack `Symbol` from a string value
impl From<&str> for Symbol {
    fn from(value: &str) -> Self {
        Symbol {
            value: String::from(value),
        }
    }
}

/// Converts from `Symbol` to a `Symbol` `Value`
impl From<Symbol> for Value {
    fn from(value: Symbol) -> Self {
        Value::Symbol(value)
    }
}

/// Tries to convert from `Value` to a `Symbol`
impl TryFrom<&Value> for Symbol {
    type Error = &'static str;
    fn try_from(value: &Value) -> Result<Self, Self::Error> {
        match value {
            Value::Symbol(v) => Ok(v.clone()),
            _ => Err("Value is not an `Symbol`"),
        }
    }
}

impl fmt::Display for Symbol {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "^{}", self.value)
    }
}