Struct mpd_protocol::response::frame::Frame

pub struct Frame { /* private fields */ }

A successful response to a command.

Consists of zero or more key-value pairs, where the keys are not unique, and optionally a single binary blob.

Implementations

impl Frame

pub fn fields_len(&self) -> usize

Get the number of key-value pairs in this response frame.

pub fn is_empty(&self) -> bool

Returns true if the frame is entirely empty, i.e. contains 0 key-value pairs and no binary blob.

pub fn has_binary(&self) -> bool

Returns true if the frame contains a binary blob.

If the binary blob has been removed using Frame::take_binary, this will return false.

pub fn fields(&self) -> Fields<'_>

Returns an iterator over all key-value pairs in this frame, in the order they appear in the response.

If keys have been removed using Frame::get, they will not appear.

pub fn find<K>(&self, key: K) -> Option<&str>

where K: AsRef<str>,

Find the first key-value pair with the given key, and return a reference to its value.

The key is case-sensitive.

pub fn binary(&self) -> Option<&[u8]>

Returns a reference to the binary blob in this frame, if there is one.

If the binary blob has been removed using Frame::take_binary, this will return None.

pub fn get<K>(&mut self, key: K) -> Option<String>

where K: AsRef<str>,

Find the first key-value pair with the given key, and return its value.

The key is case-sensitive. This removes it from the list of fields in this frame.

pub fn take_binary(&mut self) -> Option<BytesMut>

Get the binary blob contained in this frame, if present.

This will remove it from the frame, future calls to this method will return None.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a Frame

type Item = (&'a str, &'a str)

The type of the elements being iterated over.

type IntoIter = Fields<'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 Frame

type Item = (Arc<str>, String)

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Frame

fn eq(&self, other: &Frame) -> 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 Frame

impl StructuralEq for Frame

impl StructuralPartialEq for Frame