Struct mpd_protocol::response::Response

pub struct Response { /* fields omitted */ }

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.

Implementations

impl Response

pub fn new(frames: Vec<Frame>, error: Option<Error>) -> Self

Construct a new response.

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.

// This panics:
Response::new(Vec::new(), None);

pub fn empty() -> Self

Construct a new "empty" response. This is the simplest possible succesful response, consisting of a single empty frame.

let r = Response::empty();
assert_eq!(1, r.len());
assert!(r.is_success());

pub fn is_error(&self) -> bool

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.

let r = Response::new(Vec::new(), Some(Error::default()));
assert!(r.is_error());

pub fn is_success(&self) -> bool

Returns true if the response was entirely succesful (i.e. no errors).

let r = Response::new(vec![Frame::empty()], None);
assert!(r.is_success());

pub fn len(&self) -> usize

Get the number of succesful frames in the response.

May be 0 if the response only consists of an error.

let r = Response::empty();
assert_eq!(r.len(), 1);

pub fn frames(&self) -> FramesRef<'_>

Create an iterator over references to the frames in the response.

let r = Response::empty();
let mut iter = r.frames();

assert_eq!(Some(Ok(&Frame::empty())), iter.next());

pub fn single_frame(self) -> Result<Frame, Error>

Treat the response as consisting of a single frame or error.

Frames or errors beyond the first, if they exist, are silently discarded.

let r = Response::empty();
assert_eq!(Ok(Frame::empty()), r.single_frame());

Trait Implementations

impl Clone for Response

pub fn clone(&self) -> Response

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Response

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Response

impl<'a> IntoIterator for &'a Response

type Item = Result<&'a Frame, &'a Error>

The type of the elements being iterated over.

type IntoIter = FramesRef<'a>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Response

type Item = Result<Frame, Error>

The type of the elements being iterated over.

type IntoIter = Frames

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Response> for Response

pub fn eq(&self, other: &Response) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Response) -> bool

This method tests for !=.

impl StructuralEq for Response

impl StructuralPartialEq for Response