pubnub-core 0.1.0

PubNub core crate, modular and composable
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

//! Channel related types.

use std::convert::TryFrom;
use std::fmt::{self, Display};
use std::str::FromStr;

const NAME_PROHIBITED_SYMBOLS: &[char] = &[',', '/', '\\', '.', '*', ':'];

/// Name represents a channel (or a channel group) name.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Default)]
pub struct Name(String);

impl Name {
    fn is_valid(s: &str) -> bool {
        !s.contains(NAME_PROHIBITED_SYMBOLS)
    }
}

impl TryFrom<String> for Name {
    type Error = String;

    fn try_from(value: String) -> Result<Self, Self::Error> {
        if !Self::is_valid(&value) {
            return Err(value);
        }
        Ok(Self(value))
    }
}

impl FromStr for Name {
    type Err = ();

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        if !Self::is_valid(s) {
            return Err(());
        }
        Ok(Self(s.to_owned()))
    }
}

impl AsRef<String> for Name {
    fn as_ref(&self) -> &String {
        &self.0
    }
}

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

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

#[cfg(test)]
mod tests {
    use super::Name;

    #[test]
    fn name_valid() {
        assert_eq!(Name::is_valid(""), true);
        assert_eq!(Name::is_valid("qwe"), true);
        assert_eq!(Name::is_valid("123"), true);
    }

    #[test]
    fn name_invalid() {
        // Spec.
        assert_eq!(Name::is_valid(","), false);
        assert_eq!(Name::is_valid("/"), false);
        assert_eq!(Name::is_valid("\\"), false);
        assert_eq!(Name::is_valid("."), false);
        assert_eq!(Name::is_valid("*"), false);
        assert_eq!(Name::is_valid(":"), false);

        // Real world examples.
        assert_eq!(Name::is_valid("a,b"), false);
        assert_eq!(Name::is_valid("a.b"), false);
        assert_eq!(Name::is_valid("a:b"), false);
        assert_eq!(Name::is_valid("a/b"), false);
        assert_eq!(Name::is_valid("\\a"), false);
        assert_eq!(Name::is_valid("channels_.*"), false);
        assert_eq!(Name::is_valid("channels_*"), false);
    }
}