icydb-schema 0.64.1

IcyDB — A type-safe, embedded ORM and schema system for the Internet Computer
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

use crate::prelude::*;

///
/// Def
///

#[derive(CandidType, Clone, Debug, Serialize)]
pub struct Def {
    module_path: &'static str,
    ident: &'static str,
    comments: Option<&'static str>,
}

impl Def {
    /// Build one schema-definition identity triple.
    #[must_use]
    pub const fn new(
        module_path: &'static str,
        ident: &'static str,
        comments: Option<&'static str>,
    ) -> Self {
        Self {
            module_path,
            ident,
            comments,
        }
    }

    /// Borrow definition module path.
    #[must_use]
    pub const fn module_path(&self) -> &'static str {
        self.module_path
    }

    /// Borrow definition identifier.
    #[must_use]
    pub const fn ident(&self) -> &'static str {
        self.ident
    }

    /// Borrow optional definition comments.
    #[must_use]
    pub const fn comments(&self) -> Option<&'static str> {
        self.comments
    }

    // path
    // the path to the actual Type
    // ie. design::game::Rarity
    #[must_use]
    pub fn path(&self) -> String {
        format!("{}::{}", self.module_path(), self.ident())
    }
}

impl ValidateNode for Def {}

impl VisitableNode for Def {}