ruma_client_api/discovery/get_capabilities/
iter.rs

Help
1//! Iterator implementation for `Capabilities`
2
3use std::{borrow::Cow, collections::btree_map};
4
5use serde_json::Value as JsonValue;
6
7use super::Capabilities;
8
9/// Reference to a capability.
10#[derive(Debug)]
11pub struct CapabilityRef<'a> {
12    name: &'a str,
13    value: Option<&'a JsonValue>,
14    caps: &'a Capabilities,
15}
16
17impl<'a> CapabilityRef<'a> {
18    /// Get name of the capability.
19    pub fn name(&self) -> &'a str {
20        self.name
21    }
22
23    /// Get value of the capability.
24    pub fn value(&self) -> Cow<'a, JsonValue> {
25        match self.value {
26            // unknown capability from btreemap iterator
27            Some(val) => Cow::Borrowed(val),
28            // O(1) lookup of known capability
29            None => self.caps.get(self.name).unwrap(),
30        }
31    }
32}
33
34/// An iterator over capabilities.
35#[derive(Debug)]
36pub struct CapabilitiesIter<'a> {
37    /// Reference to Capabilities
38    caps: &'a Capabilities,
39    /// Current position of the iterator
40    pos: usize,
41    /// Iterator for custom capabilities
42    custom_caps_iterator: btree_map::Iter<'a, String, JsonValue>,
43}
44
45impl<'a> CapabilitiesIter<'a> {
46    /// Creates a new CapabilitiesIter
47    pub(super) fn new(caps: &'a Capabilities) -> Self {
48        Self { caps, pos: 0, custom_caps_iterator: caps.custom_capabilities.iter() }
49    }
50}
51
52impl<'a> Iterator for CapabilitiesIter<'a> {
53    type Item = CapabilityRef<'a>;
54
55    fn next(&mut self) -> Option<Self::Item> {
56        match self.pos {
57            0 => {
58                self.pos += 1;
59                Some(CapabilityRef { name: "m.change_password", value: None, caps: self.caps })
60            }
61            1 => {
62                self.pos += 1;
63                Some(CapabilityRef { name: "m.room_versions", value: None, caps: self.caps })
64            }
65            2 => {
66                self.pos += 1;
67                Some(CapabilityRef { name: "m.set_displayname", value: None, caps: self.caps })
68            }
69            3 => {
70                self.pos += 1;
71                Some(CapabilityRef { name: "m.set_avatar_url", value: None, caps: self.caps })
72            }
73            4 => {
74                self.pos += 1;
75                Some(CapabilityRef { name: "m.3pid_changes", value: None, caps: self.caps })
76            }
77            _ => self.custom_caps_iterator.next().map(|(name, value)| CapabilityRef {
78                name,
79                value: Some(value),
80                caps: self.caps,
81            }),
82        }
83    }
84}
ruma_client_api/discovery/get_capabilities/iter.rs

ruma_client_api/discovery/get_capabilities/
iter.rs
