tycho 0.1.2

A minimal, self-describing and traversable binary data format designed around rust and the serde data model.
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

use std::collections::HashMap;
use std::convert::TryFrom;
use std::ops::{Deref, DerefMut};

use crate::Element;


/// Maps to `HashMap<String, Element>`
#[derive(Debug)]
pub struct Struct(pub HashMap<String, Element>);

impl From<Struct> for Element {
    fn from(s: Struct) -> Self {
        Element::Struct(s.0)
    }
}

impl Deref for Struct {
    type Target = HashMap<String, Element>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for Struct {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl Struct {
    /// Create a new empty struct.
    pub fn new() -> Self { Self(HashMap::new()) }

    /// Insert an item into the struct.
    ///
    /// This function uses the `Into<Element>` trait.
    /// ```
    /// use tycho::collections::Struct;
    /// use tycho::Element;
    /// let mut s = Struct::new();
    /// s.insert("a", "foo");
    /// ```
    pub fn insert<V: Into<Element>>(&mut self, key: &str, value: V) -> Option<Element> {
        self.0.insert(key.to_string(), value.into())
    }

    /// Get an item from the struct.
    pub fn get(&self, key: &str) -> Option<&Element> {
        self.0.get(key)
    }

    /// Remove an item from the struct.
    pub fn remove(&mut self, key: &str) -> Option<Element> {
        self.0.remove(key)
    }

    /// Get a value from a struct with a given type
    ///
    /// ```
    /// use tycho::collections::Struct;
    /// use tycho::{Element, Value, Number};
    /// let mut s = Struct::new();
    ///
    /// // Insert
    /// s.insert("foo", 420i32);
    ///
    /// // Retrieve
    /// assert_eq!(s.get("foo"), Some(&Element::Value(Value::Number(Number::Signed32(420)))));
    /// //assert_eq!(s.value("foo"), Some(&420i32))
    /// ```
    ///
    #[doc(hidden)]
    pub fn value<'x, V: From<&'x Element>>(&'x self, key: &str) -> Option<V> {
        match V::try_from(self.0.get(key)?) {
            Ok(x) => Some(x),
            Err(_) => None
        }
    }
}
impl From<HashMap<String, Element>> for Struct {
    fn from(v: HashMap<String, Element>) -> Self {
        Self(v)
    }
}

impl TryFrom<Element> for Struct {
    type Error = ();

    fn try_from(value: Element) -> Result<Self, Self::Error> {
        if let Element::Struct(map) = value {
            Ok(Struct(map))
        } else {
            Err(())
        }
    }
}