Enum mumlib::command::Command

pub enum Command {
    ChannelJoin {
        channel_identifier: String,
    },
    ChannelList,
    ConfigReload,
    DeafenSelf(Option<bool>),
    Events {
        block: bool,
    },
    InputVolumeSet(f32),
    MuteOther(String, Option<bool>),
    MuteSelf(Option<bool>),
    OutputVolumeSet(f32),
    PastMessages {
        block: bool,
    },
    Ping,
    SendMessage {
        message: String,
        targets: MessageTarget,
    },
    ServerConnect {
        host: String,
        port: u16,
        username: String,
        password: Option<String>,
        accept_invalid_cert: bool,
    },
    ServerDisconnect,
    ServerStatus {
        host: String,
        port: u16,
    },
    Status,
    UserVolumeSet(String, f32),
}

Sent by a controller to mumd who might respond with a CommandResponse. Not all commands receive a response.

Variants

ChannelJoin

Fields

channel_identifier: String

No response.

ChannelList

Response: CommandResponse::ChannelList.

ConfigReload

Force reloading of config file from disk. No response.

DeafenSelf(Option<bool>)

Response: CommandResponse::DeafenStatus. Toggles if None.

Events

Fields

block: bool

InputVolumeSet(f32)

Set the outgoing audio volume (i.e. from you to the server). No response.

MuteOther(String, Option<bool>)

Response: CommandResponse::MuteStatus. Toggles mute state if None.

MuteSelf(Option<bool>)

Response: CommandResponse::MuteStatus. Toggles mute state if None.

OutputVolumeSet(f32)

Set the master incoming audio volume (i.e. from the server to you). No response.

PastMessages

Fields

block: bool

Request a list of past messages. Blocks while waiting for more messages if block is true. Response: multiple CommandResponse::PastMessage.

Ping

Response: CommandResponse::Pong. Used to test existance of a mumd-instance.

SendMessage

Fields

message: String

The message to send.

targets: MessageTarget

The target(s) to send the message to.

Send a message to some MessageTarget.

ServerConnect

Fields

host: String

The URL or IP-adress to connect to.

port: u16

The port to connect to.

username: String

The username to connect with.

password: Option<String>

The server password, if applicable. Not sent if None.

accept_invalid_cert: bool

Whether to accept an invalid server certificate or not.

Connect to the specified server. Response: CommandResponse::ServerConnect.

ServerDisconnect

Disconnect from the currently connected server. No response.

ServerStatus

Fields

host: String

port: u16

Send a server status request via UDP (e.g. not requiring a TCP connection). Response: CommandResponse::ServerStatus.

Status

Request the status of the current server. Response: CommandResponse::Status.

UserVolumeSet(String, f32)

The the volume of the specified user. No response.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy 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 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.