Skip to main content

ServerCommand

Enum ServerCommand 

Source
#[non_exhaustive]
pub enum ServerCommand {
Show 15 variants SetClientVolume { client_id: String, volume: u16, muted: bool, }, SetClientLatency { client_id: String, latency: i32, }, SetClientName { client_id: String, name: String, }, SetGroupStream { group_id: String, stream_id: String, }, SetGroupMute { group_id: String, muted: bool, }, SetGroupName { group_id: String, name: String, }, SetGroupClients { group_id: String, clients: Vec<String>, }, DeleteClient { client_id: String, }, SetStreamMeta { stream_id: String, metadata: HashMap<String, Value>, }, AddStream { uri: String, response_tx: Sender<Result<String, String>>, }, RemoveStream { stream_id: String, }, StreamControl { stream_id: String, command: String, params: Value, }, GetStatus { response_tx: Sender<ServerStatus>, }, SendToClient { client_id: String, message: CustomMessage, }, Stop,
}
Expand description

Commands the consumer sends to the server.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

SetClientVolume

Set a client’s volume.

Fields

§client_id: String

Client ID.

§volume: u16

Volume (0–100).

§muted: bool

Mute state.

§

SetClientLatency

Set a client’s latency offset.

Fields

§client_id: String

Client ID.

§latency: i32

Latency in milliseconds.

§

SetClientName

Set a client’s display name.

Fields

§client_id: String

Client ID.

§name: String

New name.

§

SetGroupStream

Assign a stream to a group.

Fields

§group_id: String

Group ID.

§stream_id: String

Stream ID.

§

SetGroupMute

Mute/unmute a group.

Fields

§group_id: String

Group ID.

§muted: bool

Mute state.

§

SetGroupName

Set a group’s display name.

Fields

§group_id: String

Group ID.

§name: String

New name.

§

SetGroupClients

Move clients to a group.

Fields

§group_id: String

Group ID.

§clients: Vec<String>

Client IDs.

§

DeleteClient

Delete a client from the server.

Fields

§client_id: String

Client ID.

§

SetStreamMeta

Set stream metadata (artist, title, album, etc.).

Fields

§stream_id: String

Stream ID.

§metadata: HashMap<String, Value>

Metadata key-value pairs.

§

AddStream

Dynamically add a stream source.

Fields

§uri: String

Stream source URI (e.g. pipe:///tmp/snapfifo?name=default).

§response_tx: Sender<Result<String, String>>

Response: the stream ID assigned.

§

RemoveStream

Remove a stream source.

Fields

§stream_id: String

Stream ID to remove.

§

StreamControl

Forward a control command to a stream (play, pause, next, etc.).

Fields

§stream_id: String

Stream ID.

§command: String

Command name (e.g. “next”, “previous”, “pause”, “seek”).

§params: Value

Optional command parameter (e.g. seek position).

§

GetStatus

Get full server status.

Fields

§response_tx: Sender<ServerStatus>

Response channel.

§

SendToClient

Send a custom binary protocol message to a streaming client.

Fields

§client_id: String

Target client ID.

§message: CustomMessage

The custom message.

§

Stop

Stop the server gracefully.

Trait Implementations§

Source§

impl Debug for ServerCommand

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

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 T
where U: From<T>,

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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
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