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 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
//! Complete responses. use bytes::Bytes; use std::collections::HashMap; /// Response to a command, consisting of an abitrary amount of frames, which are responses to /// individual commands, and optionally a single error. /// /// Since an error terminates a command list, there can only be one error in a response. #[derive(Debug, PartialEq, Eq)] pub struct Response { /// The sucessful responses. frames: Vec<Frame>, /// The error, if one occured. error: Option<Error>, } /// Data in a succesful response. #[derive(Debug, PartialEq, Eq)] pub struct Frame { /// Key-value pairs. Keys can repeat arbitrarily often. pub values: Vec<(String, String)>, /// Binary frame. pub binary: Option<Bytes>, } /// Data in an error. #[derive(Debug, Default, PartialEq, Eq)] pub struct Error { /// Error code. See [the MPD /// source](https://github.com/MusicPlayerDaemon/MPD/blob/master/src/protocol/Ack.hxx#L30) for /// a list of of possible values. pub code: u64, /// Index of command in a command list that caused this error. 0 when not in a command list. pub command_index: u64, /// Command that returned the error, if applicable. pub current_command: Option<String>, /// Message describing the error. pub message: String, } #[allow(clippy::len_without_is_empty)] impl Response { /// Construct a new response. /// /// ``` /// use mpd_protocol::response::{Response, Frame}; /// /// let r = Response::new(vec![Frame::empty()], None); /// assert_eq!(1, r.len()); /// assert!(r.is_success()); /// ``` /// /// # Panics /// /// Panics if it is attempted to construct an empty response (i.e. both `frames` and `error` /// are empty). This should not occur during normal operation. /// /// ```should_panic /// use mpd_protocol::response::Response; /// /// // This panics: /// Response::new(Vec::new(), None); /// ``` pub fn new(mut frames: Vec<Frame>, error: Option<Error>) -> Self { assert!( !frames.is_empty() || error.is_some(), "attempted to construct an empty (no frames or error) response" ); frames.reverse(); // We want the frames in reverse-chronological order (i.e. oldest last). Self { frames, error } } /// Construct a new "empty" response. This is the simplest possible succesful response, /// consisting of a single empty frame. /// /// ``` /// use mpd_protocol::response::Response; /// /// let r = Response::empty(); /// assert_eq!(1, r.len()); /// assert!(r.is_success()); /// ``` pub fn empty() -> Self { Self::new(vec![Frame::empty()], None) } /// Returns `true` if the response resulted in an error. /// /// Even if this returns `true`, there may still be succesful frames in the response when the /// response is to a command list. /// /// ``` /// use mpd_protocol::response::{Response, Error}; /// /// let r = Response::new(Vec::new(), Some(Error::default())); /// assert!(r.is_error()); /// ``` pub fn is_error(&self) -> bool { self.error.is_some() } /// Returns `true` if the response was entirely succesful (i.e. no errors). /// /// ``` /// use mpd_protocol::response::{Response, Frame}; /// /// let r = Response::new(vec![Frame::empty()], None); /// assert!(r.is_success()); /// ``` pub fn is_success(&self) -> bool { !self.is_error() } /// Get the number of succesful frames in the response. /// /// May be 0 if the response only consists of an error. /// /// ``` /// use mpd_protocol::response::Response; /// /// let r = Response::empty(); /// assert_eq!(r.len(), 1); /// ``` pub fn len(&self) -> usize { self.frames.len() } /// Get the next frame or error from the response as a `Result`. /// /// Includes the remaining portion of the response. A possible error always occurs as the last /// element, since it terminates command lists. /// /// ``` /// use mpd_protocol::response::{Response, Frame}; /// /// let r = Response::new(vec![Frame::empty(), Frame::empty()], None); /// let res = r.next_frame().unwrap(); /// assert_eq!(Frame::empty(), res.0); /// /// assert_eq!(Ok((Frame::empty(), None)), res.1.unwrap().next_frame()); /// ``` pub fn next_frame(mut self) -> Result<(Frame, Option<Self>), Error> { match self.frames.pop() { Some(frame) => { let remaining = if !self.frames.is_empty() || self.error.is_some() { Some(self) } else { None }; Ok((frame, remaining)) } None => Err(self.error.unwrap()), } } /// Treat the response as consisting of a single frame or error. /// /// Frames or errors beyond the first, if they exist, are silently discarded. /// /// ``` /// use mpd_protocol::response::{Frame, Response}; /// /// let r = Response::empty(); /// assert_eq!(Ok(Frame::empty()), r.single_frame()); /// ``` pub fn single_frame(self) -> Result<Frame, Error> { self.next_frame().map(|(f, _)| f) } /// Creates an iterator over all frames and errors in the response. /// /// ``` /// use mpd_protocol::response::{Frame, Response}; /// /// let mut first = vec![(String::from("hello"), String::from("world"))]; /// /// let second = vec![(String::from("foo"), String::from("bar"))]; /// /// let mut iter = Response::new(vec![Frame { /// values: first.clone(), /// binary: None, /// }, Frame { /// values: second.clone(), /// binary: None, /// }], None).frames(); /// /// assert_eq!(Some(Ok(Frame { /// values: first, /// binary: None, /// })), iter.next()); /// /// assert_eq!(Some(Ok(Frame { /// values: second, /// binary: None, /// })), iter.next()); /// /// assert_eq!(None, iter.next()); /// ``` pub fn frames(self) -> impl Iterator<Item = Result<Frame, Error>> { Frames(Some(self)) } } struct Frames(Option<Response>); impl Iterator for Frames { type Item = Result<Frame, Error>; fn next(&mut self) -> Option<Self::Item> { match self.0.take() { None => None, Some(r) => Some(match r.next_frame() { Err(e) => Err(e), Ok((value, remaining)) => { self.0 = remaining; Ok(value) } }), } } } impl Frame { /// Create an empty frame (0 key-value pairs). /// /// ``` /// use mpd_protocol::response::Frame; /// /// let f = Frame::empty(); /// assert_eq!(0, f.values.len()); /// assert!(f.binary.is_none()); /// ``` pub fn empty() -> Self { Self { values: Vec::new(), binary: None, } } /// Collect the key-value pairs in this resposne into a `HashMap`. /// /// Beware that this loses the order relationship between different keys. Values for a given /// key are ordered like they appear in the response. /// /// ``` /// use mpd_protocol::response::Frame; /// /// let f = Frame { /// values: vec![ /// (String::from("foo"), String::from("bar")), /// (String::from("hello"), String::from("world")), /// (String::from("foo"), String::from("baz")), /// ], /// binary: None, /// }; /// /// let map = f.values_as_map(); /// /// assert_eq!(map.get("foo"), Some(&vec!["bar", "baz"])); /// assert_eq!(map.get("hello"), Some(&vec!["world"])); /// ``` pub fn values_as_map(&self) -> HashMap<&str, Vec<&str>> { let mut map = HashMap::new(); for (k, v) in self.values.iter() { map.entry(k.as_str()) .or_insert_with(Vec::new) .push(v.as_str()); } map } }