orbit-core 0.5.4

Fleet-aware shared-memory rings over POSIX shared memory.
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

use std::fmt;
use std::ops::Deref;
use std::str::FromStr;
use std::sync::Arc;

/// Same-host fleet namespace, distinct from a process or application name.
///
/// One to eight ASCII letters, digits, hyphens or underscores, stored inline.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct FleetName {
    bytes: [u8; 8],
    len: u8,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct InvalidFleetName;

impl fmt::Display for InvalidFleetName {
    fn fmt(
        &self,
        f: &mut fmt::Formatter<'_>,
    ) -> fmt::Result {
        f.write_str(
            "fleet name must contain 1–8 ASCII letters, digits, '-' or '_'",
        )
    }
}

impl std::error::Error for InvalidFleetName {}

impl FleetName {
    /// Namespace API contract, independent of platform-specific SHM limits.
    pub const MAX_LEN: usize = 8;

    pub fn new(name: impl AsRef<str>) -> Self {
        Self::try_new(name).expect("invalid fleet name")
    }

    pub fn try_new(name: impl AsRef<str>) -> Result<Self, InvalidFleetName> {
        let name = name.as_ref();
        if name.is_empty()
            || name.len() > Self::MAX_LEN
            || !name
                .bytes()
                .all(|b| b.is_ascii_alphanumeric() || b == b'-' || b == b'_')
        {
            return Err(InvalidFleetName);
        }
        let mut bytes = [0; 8];
        bytes[..name.len()].copy_from_slice(name.as_bytes());
        Ok(Self { bytes, len: name.len() as u8 })
    }

    pub fn as_str(&self) -> &str {
        std::str::from_utf8(&self.bytes[..usize::from(self.len)])
            .expect("fleet name contains validated ASCII")
    }
}

impl FromStr for FleetName {
    type Err = InvalidFleetName;

    fn from_str(name: &str) -> Result<Self, Self::Err> {
        Self::try_new(name)
    }
}

impl From<&str> for FleetName {
    fn from(name: &str) -> Self {
        Self::new(name)
    }
}

impl From<String> for FleetName {
    fn from(name: String) -> Self {
        Self::new(name)
    }
}

impl From<Arc<str>> for FleetName {
    fn from(name: Arc<str>) -> Self {
        Self::new(name)
    }
}

impl From<FleetName> for Arc<str> {
    fn from(name: FleetName) -> Self {
        Arc::from(name.as_str())
    }
}

impl From<FleetName> for String {
    fn from(name: FleetName) -> Self {
        name.as_str().to_owned()
    }
}

impl AsRef<str> for FleetName {
    fn as_ref(&self) -> &str {
        self.as_str()
    }
}

impl Deref for FleetName {
    type Target = str;

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

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