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

use serde::{Deserialize, Serialize};

use super::{Operand, Operator};

/// Represents the narrow filter used to restrict results.
#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
pub struct NarrowTuple(Operator, Operand);

impl NarrowTuple {
    /// Creates a new [NarrowTuple].
    pub const fn new() -> Self {
        Self(Operator::new(), Operand::new())
    }

    /// Creates a new [NarrowTuple] from the provide parameters.
    pub const fn create(operator: Operator, operand: Operand) -> Self {
        Self(operator, operand)
    }

    /// Gets the [NarrowTuple] operator.
    pub const fn operator(&self) -> &Operator {
        &self.0
    }

    /// Sets the [NarrowTuple] operator.
    pub fn set_operator(&mut self, val: Operator) {
        self.0 = val;
    }

    /// Builder function that sets the [NarrowTuple] operator.
    pub fn with_operator(self, val: Operator) -> Self {
        Self(val, self.1)
    }

    /// Gets the [NarrowTuple] operand.
    pub const fn operand(&self) -> &Operand {
        &self.1
    }

    /// Sets the [NarrowTuple] operand.
    pub fn set_operand(&mut self, val: Operand) {
        self.1 = val;
    }

    /// Builder function that sets the [NarrowTuple] operand.
    pub fn with_operand(self, val: Operand) -> Self {
        Self(self.0, val)
    }
}

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

impl std::fmt::Display for NarrowTuple {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        serde_json::to_string(self)
            .map_err(|_| std::fmt::Error)
            .and_then(|s| write!(f, "{s}"))
    }
}

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

    #[test]
    fn test_narrow_tuple() {
        [
            (Operator::Channel, Operand::from(1)),
            (Operator::Channel, Operand::from("general")),
            (Operator::Channels, Operand::from([1, 2])),
            (Operator::Channels, Operand::from(["general", "test"])),
            (Operator::Dm, Operand::from(1)),
            (Operator::Dm, Operand::from("test_user")),
            (Operator::Is, Operand::from(1)),
            (Operator::NotIs, Operand::from(["general", "test"])),
            (Operator::Near, Operand::from(1)),
        ]
        .into_iter()
        .for_each(|(opor, opand)| {
            let opor_json = serde_json::to_string(&opor).unwrap();
            let opand_json = serde_json::to_string(&opand).unwrap();

            let narrow = NarrowTuple::create(opor, opand.clone());
            let narrow_json = format!(r#"[{opor_json},{opand_json}]"#);

            assert_eq!(narrow.operator(), &opor);
            assert_eq!(narrow.operand(), &opand);

            assert_eq!(serde_json::to_string(&narrow).unwrap(), narrow_json);
            assert_eq!(
                serde_json::from_str::<NarrowTuple>(&narrow_json).unwrap(),
                narrow
            );
        });
    }
}