Struct mpd_protocol::response::Response

pub struct Response { /* private fields */ }

Response to a command, consisting of an arbitrary 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 is_error(&self) -> bool

Returns true if the response contains an error.

Even if this returns true, there may still be successful frames in the response when the response is to a command list.

pub fn is_success(&self) -> bool

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

pub fn successful_frames(&self) -> usize

Get the number of successful frames in the response.

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

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

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

This yields Results, with successful frames becoming Ok()s and an error becoming a (final) Err().

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

Extract the first frame or error from the response.

Any additional frames are discarded. This is useful for responses to single commands.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

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?

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?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Response

impl StructuralPartialEq for Response