Enum Command 

pub enum Command {
    Play {
        slug: Option<String>,
    },
    Pause,
    Toggle,
    Stop,
    Seek {
        position_secs: Option<f64>,
        delta_secs: Option<f64>,
    },
    Next,
    Previous,
    Download {
        slug: String,
    },
    CancelDownload {
        slug: String,
    },
    DeleteDownload {
        slug: String,
    },
    Favourite {
        slug: String,
    },
    Unfavourite {
        slug: String,
    },
    ListFavourites,
    Preferences {
        inverted_palette: Option<bool>,
    },
    Status,
    ListCatalog,
    Subscribe {
        spectrum: bool,
    },
    Shutdown,
}

The command surface the daemon accepts.

Variants

Play

Start the named episode, or resume the loaded one when no slug is given.

Fields

slug: Option<String>

Pause

Toggle

Stop

Seek

Seek to an absolute position or by a signed offset. Exactly one of the two.

Fields

position_secs: Option<f64>

delta_secs: Option<f64>

Next

Previous

Download

Begin or resume an offline download; returns before the transfer finishes.

Fields

slug: String

CancelDownload

Fields

slug: String

DeleteDownload

Remove an episode’s local copy, so no client has to unlink a file the daemon is accounting for.

Fields

slug: String

Favourite

Mark an episode a favourite. Marking one already marked is not an error.

Fields

slug: String

Unfavourite

Unmark a favourite. Unmarking one not marked is not an error.

Fields

slug: String

ListFavourites

Preferences

Read the interface’s display preferences, and set whichever of them are given.

One command rather than a read and a write: an omitted field is left alone, so a read is this command with the field absent and a client never has to read a preference back before changing it. These belong to the interface, not to playback, and setting one has no effect on what the daemon is playing.

Unknown fields are ignored, so a client still sending the cookie notice’s dismissal - a preference this interface no longer has - is answered rather than refused.

Fields

inverted_palette: Option<bool>

Status

ListCatalog

Return the catalog the daemon holds, so no client has to read its cache file.

Subscribe

Start receiving pushed state events on this connection.

Fields

spectrum: bool

Whether this connection wants snapshots pushed for spectrum changes.

Defaults to false so a client that does not draw an analyser is never woken twenty times a second for a field it ignores.

Shutdown

Stop audio, persist state, and exit. The only command that ends the process.

Implementations

impl Command

pub fn type_name(&self) -> &'static str

pub fn validate(&self) -> Result<()>

Checks arguments that parsed structurally but must still fall inside their permitted domain.

seek takes exactly one of position_secs or delta_secs, and that one must be a duration the engine can hold. Anything else is ErrorCode::InvalidParams.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Command

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Command

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Command

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Command