pub struct PersistentClient<'a> { /* private fields */ }
Expand description

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§

source§

impl<'a> PersistentClient<'a>

source

pub fn new(host: &'a str, retry_interval: Duration) -> Self

source

pub fn init(&self)

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

source

pub fn host(&self) -> &str

Gets the client host address or path

source

pub fn is_connected(&self) -> bool

Gets whether there is a valid connection to the server

source

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.

source

pub async fn with_client<F, Fut, T>(&self, f: F) -> Twhere F: FnOnce(Arc<Client>) -> Fut, Fut: Future<Output = T>,

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

source

pub async fn recv(&self) -> Option<ConnectionEvent>

Receives an event from the MPD server.

source

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

Runs the status command on the MPD server.

source

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

Runs the currentsong command on the MPD server.

Trait Implementations§

source§

impl<'a> Debug for PersistentClient<'a>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> Default for PersistentClient<'a>

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

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for PersistentClient<'a>

§

impl<'a> Send for PersistentClient<'a>

§

impl<'a> Sync for PersistentClient<'a>

§

impl<'a> Unpin for PersistentClient<'a>

§

impl<'a> !UnwindSafe for PersistentClient<'a>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more