harmos-domain 0.1.0

Harmos domain model: identifiers, contracts, catalogs and storage identities.
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

/* ***
 *
 * Harmos
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * ***
 */

/* === Modules === */

/* === Re-Exports === */

pub use crate::inventory::observers::Entry as ObserverEntry;
pub use crate::inventory::publications::Entry as PublicationEntry;
pub use crate::listeners::Entry as ListenerEntry;
pub use crate::operations::{Entry as OperationEntry, WireDeclaration as WireEntry};
pub use crate::plugin::Requirement as RequirementEntry;

/* === Imports === */

// Standard Library Imports

// Third Party Imports

// Local Imports

/* === Constants === */

/* === Macros === */

/* === Type Aliases === */

/* === Structs === */

/* === Enums === */

pub enum Node<E: 'static> {
    Leaf(E),
    Nested(&'static [Node<E>]),
}

/* === Traits === */

pub trait Visitor {
    type Entry: 'static;
}

pub trait Member<T>: Visitor {
    const ENTRY: Self::Entry;
}

pub trait Projection<E> {
    const LEN: usize;

    fn try_for_each<F>(&self, visit: impl FnMut(&E) -> Result<(), F>) -> Result<(), F>;
}

pub trait InertCatalog<V: Visitor<Entry = E>, E: 'static> {
    const ENTRIES: &'static [Node<E>];
    const LEN: usize = count(Self::ENTRIES);
}

pub trait Catalog<V: Visitor> {
    type Entries: Projection<V::Entry>;
    const ENTRIES: Self::Entries;
}

pub trait Contains<T> {}

/* === Implementations === */

impl<E, const N: usize> Projection<E> for [E; N] {
    const LEN: usize = N;

    fn try_for_each<F>(&self, mut visit: impl FnMut(&E) -> Result<(), F>) -> Result<(), F> {
        for entry in self {
            visit(entry)?;
        }
        Ok(())
    }
}

impl<E> Projection<E> for () {
    const LEN: usize = 0;

    fn try_for_each<F>(&self, _: impl FnMut(&E) -> Result<(), F>) -> Result<(), F> {
        Ok(())
    }
}

impl<E, L: Projection<E>, R: Projection<E>> Projection<E> for (L, R) {
    const LEN: usize = match L::LEN.checked_add(R::LEN) {
        Some(len) => len,
        None => panic!("catalog leaf count overflows usize"),
    };

    fn try_for_each<F>(&self, mut visit: impl FnMut(&E) -> Result<(), F>) -> Result<(), F> {
        self.0.try_for_each(&mut visit)?;
        self.1.try_for_each(visit)
    }
}

impl<V: Visitor> Catalog<V> for () {
    type Entries = [V::Entry; 0];
    const ENTRIES: Self::Entries = [];
}

impl<V: Visitor<Entry = E>, E: 'static> InertCatalog<V, E> for () {
    const ENTRIES: &'static [Node<E>] = &[];
}

/* === Public Functions === */

pub const fn count<E>(nodes: &[Node<E>]) -> usize {
    let mut len: usize = 0;
    let mut index = 0;
    while index < nodes.len() {
        let added = match &nodes[index] {
            Node::Leaf(_) => 1,
            Node::Nested(nested) => count(nested),
        };
        len = match len.checked_add(added) {
            Some(len) => len,
            None => panic!("catalog leaf count overflows usize"),
        };
        index += 1;
    }
    len
}

pub fn try_for_each<E, F>(nodes: &[Node<E>], mut visit: impl FnMut(&E) -> Result<(), F>) -> Result<(), F> {
    visit_nodes(nodes, &mut visit)
}

/* === Private Functions === */

fn visit_nodes<E, F>(nodes: &[Node<E>], visit: &mut impl FnMut(&E) -> Result<(), F>) -> Result<(), F> {
    for node in nodes {
        match node {
            Node::Leaf(entry) => visit(entry)?,
            Node::Nested(nested) => visit_nodes(nested, visit)?,
        }
    }
    Ok(())
}

/* === Tests === */