Struct IdleClient 

pub struct IdleClient { /* private fields */ }

MPD client for “idle” connections.

Introduction

This is an MPD client designed to “idle”: it opens a long-lived connection to the MPD server and waits for MPD to respond with a message indicating that there’s been a change to a subsystem of interest. At present, there are only two subsystems in which mpdpopm is interested: the player & messages (cf. IdleSubSystem).

use std::path::Path;
use tokio::runtime::Runtime;
use mpdpopm::clients::IdleClient;

let mut rt = Runtime::new().unwrap();
rt.block_on( async {
    let mut client = IdleClient::open(Path::new("/var/run/mpd.sock")).await.unwrap();
    client.subscribe("player").await.unwrap();
    client.idle().await.unwrap();
    // Arrives here when the player's state changes
})

client is now a Future that resolves to an IdleClient instance talking to /var/run/mpd.sock.

Implementations

impl IdleClient

pub async fn connect<A: ToSocketAddrs>(addr: A) -> Result<IdleClient>

Create a new mpdpopm::client::IdleClient instance from something that implements ToSocketAddrs

pub async fn open<P: AsRef<Path>>(pth: P) -> Result<IdleClient>

pub fn new(stream: Box<dyn RequestResponse>) -> Result<IdleClient>

pub async fn subscribe(&mut self, chan: &str) -> Result<()>

Subscribe to an mpd channel

pub async fn idle(&mut self) -> Result<IdleSubSystem>

Enter idle state– return the subsystem that changed, causing the connection to return. NB this may block for some time.

pub async fn get_messages(&mut self) -> Result<HashMap<String, Vec<String>>>

This method simply returns the results of a “readmessages” as a HashMap of channel name to Vec of (String) messages for that channel