dazeus 0.4.0

Dazeus IRC bot bindings for rust
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

use serialize::json::{ToJson, Json, Array};

/// A scope for retrieving permissions and properties.
///
/// A scope is an optional limitation on which some property or permission applies. A scope
/// consists of three different elements:
///
/// * The `network` indicates for which network some property or permission should be stored.
/// * The `sender` indicates the IRC user for which some property or permission should be stored.
/// * The `receiver` indicates the channel for which some property or permission should be stored.
///
/// Note that for a sender or receiver scope, you also should provide a network, as it makes no
/// sense to for example provide a permission to the same channel on different networks (they are
/// only the same in name, but might be completely different in context).
///
/// The most generic scope (and easiest one to start with) is one applied to everything. Such a
/// scope can be created by the `Scope::any()` method.
#[derive(Debug, Clone, PartialEq)]
pub struct Scope {
    /// The network on which the scope is limited (if any).
    pub network: Option<String>,

    /// The sender on which the scope is limited (if any).
    pub sender: Option<String>,

    /// The receiver on which the scope is limited (if any).
    pub receiver: Option<String>,
}

impl Scope {
    /// Construct a new scope with the specified limitations for network, sender and receiver
    pub fn new(network: Option<String>, sender: Option<String>, receiver: Option<String>) -> Scope {
        Scope { network: network, sender: sender, receiver: receiver }
    }

    /// Scope to everyone and anything
    pub fn any() -> Scope {
        Scope::new(None, None, None)
    }

    /// Scope to a specific network
    pub fn network(network: &str) -> Scope {
        Scope::new(Some(network.to_string()), None, None)
    }

    /// Scope to a specific sender (typically a channel)
    pub fn sender(network: &str, sender: &str) -> Scope {
        Scope::new(Some(network.to_string()), Some(sender.to_string()), None)
    }

    /// Scope to a specific receiver (typically a user)
    pub fn receiver(network: &str, receiver: &str) -> Scope {
        Scope::new(Some(network.to_string()), None, Some(receiver.to_string()))
    }

    /// Scope to a specific receiver and channel (typically a user in a channel)
    pub fn to(network: &str, sender: &str, receiver: &str) -> Scope {
        Scope::new(Some(network.to_string()), Some(sender.to_string()), Some(receiver.to_string()))
    }

    /// Checks whether the scope is set to be applied to everything.
    pub fn is_any(&self) -> bool {
        self.network == None && self.sender == None && self.receiver == None
    }
}

impl ToJson for Scope {
    fn to_json(&self) -> Json {
        let mut arr = Array::new();
        if self.network.is_some() || self.sender.is_some() || self.receiver.is_some() {
            arr.push(match self.network {
                None => Json::Null,
                Some(ref s) => Json::String(s.clone()),
            });

            if self.sender.is_some() || self.receiver.is_some() {
                arr.push(match self.sender {
                    None => Json::Null,
                    Some(ref s) => Json::String(s.clone()),
                });

                if let Some(ref s) = self.receiver {
                    arr.push(Json::String(s.clone()));
                }
            }
        }
        Json::Array(arr)
    }
}