Struct PersistentClient

pub struct PersistentClient { /* private fields */ }

MPD client which automatically attempts to reconnect if the connection cannot be established or is lost.

Commands sent to a disconnected client are queued.

Implementations

impl PersistentClient

pub fn new(host: String, retry_interval: Duration) -> Self

pub fn init(&self)

Attempts to connect to the MPD host and begins listening to server events.

pub fn host(&self) -> &str

Gets the client host address or path

pub fn is_connected(&self) -> bool

Gets whether there is a valid connection to the server

pub async fn wait_for_client(&self) -> Arc<Client>

Waits for a valid connection to the server to be established. If already connected, resolves immediately.

pub async fn with_client<F, Fut, T>(&self, f: F) -> T

where F: FnOnce(Arc<Client>) -> Fut, Fut: Future<Output = T>,

Runs the provided callback as soon as the connected client is available.

pub async fn recv(&mut self) -> Result<Arc<ConnectionEvent>, RecvError>

Receives an event from the MPD server.

pub fn subscribe(&self) -> Receiver<Arc<ConnectionEvent>>

Creates a new receiver to be able to receive events outside the context of &self.

When you have access to the client instance, prefer recv() instead.

pub async fn command<C: Command>( &self, cmd: C, ) -> Result<C::Response, CommandError>

Runs the provided command on the MPD server.

Waits for a valid connection and response before the future is completed.

pub async fn status(&self) -> Result<Status, CommandError>

Runs the status command on the MPD server.

Waits for a valid connection and response before the future is completed.

pub async fn current_song(&self) -> Result<Option<SongInQueue>, CommandError>

Runs the currentsong command on the MPD server.

Waits for a valid connection and response before the future is completed.

Trait Implementations

impl Debug for PersistentClient

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

Formats the value using the given formatter.

impl Default for PersistentClient

Creates a new client on the default localhost TCP address with a connection retry of 5 seconds.

fn default() -> Self

Returns the “default value” for a type.