Struct mpd_protocol::response::Response

pub struct Response {
    pub frames: Vec<Frame>,
    pub error: Option<Error>,
}

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.

Fields

frames: Vec<Frame>

The sucessful responses.

error: Option<Error>

The error, if one occured.

Methods

impl Response

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

Construct a new response.

use mpd_protocol::response::{Response, Frame};

let r = Response::new(vec![Frame::default()], None);
assert_eq!(1, r.frames.len());
assert!(r.error.is_none());

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.

use mpd_protocol::response::Response;

// 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.

use mpd_protocol::response::Response;

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

pub fn is_error(&self) -> bool

Returns true if the response resulted in an error.

use mpd_protocol::response::{Response, Error};

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).

use mpd_protocol::response::{Response, Frame};

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

Trait Implementations

impl Eq for Response

impl PartialEq<Response> for Response

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

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

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

This method tests for !=.

impl Debug for Response

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl StructuralPartialEq for Response

impl StructuralEq for Response