zulip-api 0.0.8

Client library for interacting with the Zulip API
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

//! UUID helpsrs.

use serde::{Deserialize, Deserializer, Serialize, Serializer};

use crate::error::Error;

/// Represents a message UUID.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct Uuid(uuid::Uuid);

impl Uuid {
    /// Creates a new [Uuid].
    pub const fn new() -> Self {
        Self(uuid::Uuid::nil())
    }

    /// Converts an inner representation into a [Uuid].
    pub const fn from_inner(uuid: uuid::Uuid) -> Self {
        Self(uuid)
    }

    /// Converts the [Uuid] into its inner representation.
    pub const fn into_inner(self) -> uuid::Uuid {
        self.0
    }
}

impl Default for Uuid {
    fn default() -> Self {
        Self::new()
    }
}

impl TryFrom<&str> for Uuid {
    type Error = Error;

    fn try_from(val: &str) -> Result<Self, Self::Error> {
        uuid::Uuid::parse_str(val).map(Self).map_err(Error::from)
    }
}

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

    fn try_from(val: String) -> Result<Self, Self::Error> {
        Self::try_from(val.as_str())
    }
}

impl From<Uuid> for String {
    fn from(val: Uuid) -> Self {
        Self::from(&val)
    }
}

impl From<&Uuid> for String {
    fn from(val: &Uuid) -> Self {
        val.0
            .hyphenated()
            .encode_lower(&mut uuid::Uuid::encode_buffer())
            .to_string()
    }
}

impl Serialize for Uuid {
    fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        uuid::fmt::Hyphenated::from_uuid(self.0).serialize(s)
    }
}

impl<'de> Deserialize<'de> for Uuid {
    fn deserialize<D>(d: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        use serde::de::Error as _;

        String::deserialize(d)
            .as_deref()
            .map_err(|err| D::Error::custom(format!("missing UUID string: {err}")))
            .and_then(|u| {
                uuid::Uuid::parse_str(u)
                    .map(Self)
                    .map_err(|err| D::Error::custom(format!("error parsing UUID: {err}")))
            })
    }
}

impl std::fmt::Display for Uuid {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", String::from(self))
    }
}

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

    #[test]
    fn test_uuid() {
        let uuid_str = "936da01f-9abd-4d9d-80c7-02af85c822a8";
        let uuid_json = serde_json::to_string(&uuid_str).unwrap();
        let inner_uuid = uuid::Uuid::parse_str(uuid_str).unwrap();
        let uuid = Uuid::from_inner(inner_uuid);

        assert_eq!(Uuid::try_from(uuid_str), Ok(uuid));
        assert_eq!(Uuid::try_from(uuid_str.to_string()), Ok(uuid));

        assert_eq!(uuid.into_inner(), inner_uuid);
        assert_eq!(format!("{uuid}").as_str(), uuid_str);

        assert_eq!(serde_json::to_string(&uuid).unwrap(), uuid_json);
        assert_eq!(serde_json::from_str::<Uuid>(&uuid_json).unwrap(), uuid);
    }
}