nornir 0.4.1

Companion to cargo: dependency tracking, release gating, deploy, benchmarks, and documentation assembly. Project-agnostic.
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

//! Typed id wrappers. Newtypes keep idea/plan/node/run ids from being
//! mixed up at call sites. Underlying representation is a short
//! string so the log stays human-readable (`i-001`, `p-001`, `n-003`,
//! `r-7f3a`) — uuids are optional for plugins that want them.

use serde::{Deserialize, Serialize};
use std::fmt;

macro_rules! id_newtype {
    ($name:ident, $prefix:literal) => {
        #[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
        #[serde(transparent)]
        pub struct $name(pub String);

        impl $name {
            pub fn new(raw: impl Into<String>) -> Self {
                Self(raw.into())
            }

            /// Generate a fresh id with a stable prefix. Counter is
            /// the caller's responsibility — the funnel passes the
            /// current high-water mark so ids stay monotonic.
            pub fn seq(n: u64) -> Self {
                Self(format!("{}-{:03}", $prefix, n))
            }

            pub fn as_str(&self) -> &str {
                &self.0
            }
        }

        impl fmt::Display for $name {
            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                f.write_str(&self.0)
            }
        }

        impl From<&str> for $name {
            fn from(s: &str) -> Self {
                Self(s.to_owned())
            }
        }

        impl From<String> for $name {
            fn from(s: String) -> Self {
                Self(s)
            }
        }
    };
}

id_newtype!(IdeaId, "i");
id_newtype!(PlanId, "p");
id_newtype!(NodeId, "n");
id_newtype!(RunId, "r");