celerity 0.1.0

Pure Rust sans-IO ZMTP 3.1 messaging core with Tokio TCP and Unix socket transports.
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

use std::fmt;
use std::net::SocketAddr;
#[cfg(unix)]
use std::path::{Path, PathBuf};

use crate::LinkScope;

use super::TokioCelerityError;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum TransportKind {
    Tcp,
    Ipc,
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum Endpoint {
    Tcp(String),
    #[cfg(unix)]
    Ipc(PathBuf),
}

impl Endpoint {
    pub fn parse(endpoint: &str) -> Result<Self, TokioCelerityError> {
        if let Some(target) = endpoint.strip_prefix("tcp://") {
            if target.is_empty() {
                return Err(TokioCelerityError::InvalidEndpoint(endpoint.to_owned()));
            }
            return Ok(Self::Tcp(target.to_owned()));
        }

        #[cfg(unix)]
        if let Some(path) = endpoint.strip_prefix("ipc://") {
            if path.is_empty() {
                return Err(TokioCelerityError::InvalidEndpoint(endpoint.to_owned()));
            }
            let path = PathBuf::from(path);
            if !path.is_absolute() {
                return Err(TokioCelerityError::InvalidEndpoint(endpoint.to_owned()));
            }
            return Ok(Self::Ipc(path));
        }

        #[cfg(not(unix))]
        if endpoint.starts_with("ipc://") {
            return Err(TokioCelerityError::UnsupportedEndpoint(endpoint.to_owned()));
        }

        if endpoint.contains("://") {
            return Err(TokioCelerityError::UnsupportedEndpoint(endpoint.to_owned()));
        }

        if endpoint.is_empty() {
            return Err(TokioCelerityError::InvalidEndpoint(endpoint.to_owned()));
        }

        Ok(Self::Tcp(endpoint.to_owned()))
    }

    pub fn transport_kind(&self) -> TransportKind {
        match self {
            Self::Tcp(_) => TransportKind::Tcp,
            #[cfg(unix)]
            Self::Ipc(_) => TransportKind::Ipc,
        }
    }

    pub(crate) fn tcp_target(&self) -> Result<&str, TokioCelerityError> {
        match self {
            Self::Tcp(target) => Ok(target),
            #[cfg(unix)]
            Self::Ipc(_) => Err(TokioCelerityError::UnsupportedEndpoint(self.to_string())),
        }
    }

    #[cfg(unix)]
    pub(crate) fn ipc_path(&self) -> Result<&Path, TokioCelerityError> {
        match self {
            Self::Ipc(path) => Ok(path.as_path()),
            Self::Tcp(_) => Err(TokioCelerityError::UnsupportedEndpoint(self.to_string())),
        }
    }

    pub(crate) fn from_local_addr(addr: SocketAddr) -> Self {
        Self::Tcp(addr.to_string())
    }
}

impl fmt::Display for Endpoint {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Tcp(target) => write!(f, "{target}"),
            #[cfg(unix)]
            Self::Ipc(path) => write!(f, "ipc://{}", path.display()),
        }
    }
}

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

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct BindOptions {
    pub ipc_mode: u32,
    pub remove_stale_socket: bool,
    pub remove_on_drop: bool,
    pub create_parent_dirs: bool,
}

impl Default for BindOptions {
    fn default() -> Self {
        Self {
            ipc_mode: 0o600,
            remove_stale_socket: true,
            remove_on_drop: true,
            create_parent_dirs: false,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct TransportMeta {
    pub kind: TransportKind,
    pub link_scope: LinkScope,
    pub null_authorized: bool,
}