alexandria 0.2.0

An encrypted document-oriented database with tag based query support
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

use serde::{Deserialize, Serialize};
use std::fmt::{self, Display, Formatter};

/// An in-database path segment
///
/// Each path in the database needs to be unique in it's scope (user
/// or global).  A path is terminated by the leaf element, also knows
/// as the record-id.  This does however not mean that the path
/// becomes blocked for future writes to add further subseqs.
///
/// - Path A: `/foo/bar:baz`
/// - Path B: `/foo/bar/baz:beep`
///
/// Are both valid and will not collide.
///
/// ## String representation
///
/// An alexandria path can be represented as a string with `:` and `/`
/// acting as delimiters.  Following are some valid examples that can
/// be parsed from strings (or turned into strings).
///
/// - `/msg/private:bob`: msg -> private -> bob
/// - `/msg/private/bob:imgs`: msg -> private -> bob -> imgs
/// - `/sessions:all` -> sessions -> all
///
/// The following code can be used to create Path objects from
/// strings:
///
/// ```rust
/// # use alexandria::utils::Path;
/// let _: Path = "/test:data".into();
/// ```
///
/// ## Util macro
///
/// If you want to create paths from identifiers, not just strings, or
/// if you want to avoid stringly typed paths, you can also use the
/// `mkPath!` macro in the same module.
///
/// ```rust,ignore
/// # use alexandria::path::mkPath;
/// let _: Path = mkPath!("imgs", "bob", "cool");
/// ```
///
///
#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub struct Path {
    leaf: String,
    seq: Vec<String>,
}

impl Path {
    pub fn leaf(&self) -> &str {
        self.leaf.as_str()
    }
}

impl Display for Path {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "{}", String::from(self))
    }
}

impl From<&Path> for String {
    fn from(p: &Path) -> String {
        format!("/{}:{}", p.seq.join("/"), p.leaf)
    }
}

impl From<String> for Path {
    fn from(s: String) -> Self {
        s.as_str().into()
    }
}

impl<'path> From<&'path str> for Path {
    fn from(s: &'path str) -> Self {
        let mut vec: Vec<_> = s.split(":").collect();
        let leaf = vec.remove(1).to_string();
        let seq = vec
            .remove(0)
            .split("/")
            .filter(|seg| seg != &"")
            .map(|s| s.to_string())
            .collect();
        Self { leaf, seq }
    }
}

#[test]
fn parse_path_simple() {
    let path = "/msg:bob";
    let Path { leaf, seq } = path.into();

    assert_eq!(leaf, "bob".to_string());
    assert_eq!(seq, vec!["msg".to_string()]);
}