aranya-client 6.0.0

Client library for using Aranya
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

use std::vec;

use aranya_daemon_api as api;
use aranya_id::custom_id;
use aranya_policy_text::Text;

use crate::{
    client::DeviceId,
    util::{impl_vec_into_iter_wrapper, ApiConv as _, ApiId},
};

custom_id! {
    /// An AFC label ID.
    pub struct LabelId;
}
impl ApiId<api::LabelId> for LabelId {}

/// A label.
#[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
#[non_exhaustive]
pub struct Label {
    /// Uniquely identifies the label.
    pub id: LabelId,
    /// The human-readable label name.
    pub name: Text,
    /// The device that created the label.
    pub author_id: DeviceId,
}

impl Label {
    pub(crate) fn from_api(v: api::Label) -> Self {
        Self {
            id: LabelId::from_api(v.id),
            name: v.name,
            author_id: DeviceId::from_api(v.author_id),
        }
    }
}

/// List of labels.
#[derive(Clone, Debug)]
pub struct Labels {
    pub(super) labels: Box<[Label]>,
}

impl Labels {
    /// Returns an iterator over the labels.
    pub fn iter(&self) -> impl Iterator<Item = &Label> {
        self.labels.iter()
    }

    #[doc(hidden)]
    pub fn __data(&self) -> &[Label] {
        &self.labels
    }
}

impl IntoIterator for Labels {
    type Item = Label;
    type IntoIter = IntoIterLabels;

    fn into_iter(self) -> Self::IntoIter {
        IntoIterLabels(self.labels.into_vec().into_iter())
    }
}

/// An owning iterator over [`Label`]s.
#[derive(Clone, Debug)]
pub struct IntoIterLabels(vec::IntoIter<Label>);

impl_vec_into_iter_wrapper!(IntoIterLabels for Label);