Struct mpd_client::client::Client

pub struct Client(_);

Client for MPD.

Methods

impl Client

pub async fn connect<C>(
    connection: C
) -> Result<(Self, impl Stream<Item = Result<Subsystem, StateChangeError>>), MpdCodecError> where
    C: AsyncRead + AsyncWrite + Send + 'static, 

Connect to the MPD server using the given connection.

Returns a Client you can use to issue commands, and a stream of state change events as returned by MPD.

Since this is generic over the connection type, you can use it with both TCP and Unix socket connections.

Panics

Since this spawns a task internally, this will panic when called outside a tokio runtime.

Errors

This will return an error if sending the initial commands over the given transport fails.

pub async fn command<'_>(
    &'_ self,
    command: Command
) -> Result<Frame, CommandError>

Send the given command, and return the response to it.

Errors

This will return an error if the connection to MPD is closed (cleanly) or a protocol error occurs (including IO errors), or if the command results in an MPD error.

pub async fn command_list<'_>(
    &'_ self,
    commands: CommandList
) -> Result<Vec<Frame>, CommandError>

Send the given command list, and return the responses to the contained commands.

Errors

Errors will be returned in the same conditions as with command, but if any of the commands in the list return an error condition, the entire list will be treated as an error. You may recover possible succesful fields in a response from the error variant.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.