sonor 2.0.0

a library for controlling sonos speakers
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
119
120
121

use crate::Result;
use roxmltree::Node;
use std::{
    cmp::PartialEq,
    fmt,
    hash::{Hash, Hasher},
};

/// This enum describes how Sonos repeats the current playlist.
#[derive(Debug, Default)]
pub enum RepeatMode {
    /// The playlist doesn't get repeated.
    #[default]
    None,
    /// Only one song gets played on and on.
    One,
    /// The whole playlist is repeated.
    All,
}

impl fmt::Display for RepeatMode {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt::Debug::fmt(self, f)
    }
}

#[derive(Debug)]
pub struct ParseRepeatModeError;
impl std::error::Error for ParseRepeatModeError {}
impl std::fmt::Display for ParseRepeatModeError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        "provided string was not `NONE` or `ONE` or `ALL`".fmt(f)
    }
}

impl std::str::FromStr for RepeatMode {
    type Err = ParseRepeatModeError;

    fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
        match s.to_lowercase().as_ref() {
            "none" => Ok(RepeatMode::None),
            "one" => Ok(RepeatMode::One),
            "all" => Ok(RepeatMode::All),
            _ => Err(ParseRepeatModeError),
        }
    }
}

/// A more lightweight representation of a speaker containing only the name, uuid and location.
/// It gets returned by the [zone_group_state](struct.Speaker.html#method.zone_group_state) function.
#[derive(Debug, Eq)]
pub struct SpeakerInfo {
    pub(crate) name: String,
    pub(crate) uuid: String,
    pub(crate) location: String,
}
impl PartialEq for SpeakerInfo {
    fn eq(&self, other: &Self) -> bool {
        self.uuid().eq_ignore_ascii_case(other.uuid())
    }
}
impl Hash for SpeakerInfo {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.uuid.hash(state);
    }
}

#[allow(missing_docs)]
impl SpeakerInfo {
    pub(crate) fn from_xml(node: Node<'_, '_>) -> Result<Self> {
        let mut uuid = None;
        let mut name = None;
        let mut location = None;

        for attr in node.attributes() {
            match attr.name().to_lowercase().as_str() {
                "uuid" => uuid = Some(attr.value()),
                "location" => location = Some(attr.value()),
                "zonename" => name = Some(attr.value()),
                _ => (),
            }
        }

        Ok(Self {
            name: name
                .ok_or_else(|| {
                    rupnp::Error::XmlMissingElement(
                        "RoomName".to_string(),
                        "ZoneGroupMember".to_string(),
                    )
                })?
                .to_string(),
            uuid: uuid
                .ok_or_else(|| {
                    rupnp::Error::XmlMissingElement(
                        "UUID".to_string(),
                        "ZoneGroupMember".to_string(),
                    )
                })?
                .to_string(),
            location: location
                .ok_or_else(|| {
                    rupnp::Error::XmlMissingElement(
                        "Location".to_string(),
                        "ZoneGroupMember".to_string(),
                    )
                })?
                .to_string(),
        })
    }

    pub fn name(&self) -> &str {
        &self.name
    }
    pub fn uuid(&self) -> &str {
        &self.uuid
    }
    pub fn location(&self) -> &str {
        &self.location
    }
}