Struct Sound 

pub struct Sound<S = String> {
    pub fname: S,
    pub volume: u8,
    pub repeat: AudioRepetition,
    pub priority: u8,
    pub class: Option<S>,
    pub url: Option<S>,
}

Sound triggers are WAV format files intended for sound effects.

See MXP specification: <SOUND> and the MSP (Mud Sound Protocol) specification.

Examples

use mxp::AudioRepetition;

assert_eq!(
    "<SOUND 'weather/rain.wav' V=80 L=3 P=10 T=combat U='http://example.org:5000/sound'>".parse::<mxp::Sound>(),
    Ok(mxp::Sound {
        fname: "weather/rain.wav".into(),
        volume: 80,
        repeat: AudioRepetition::Count(3.try_into().unwrap()),
        priority: 10,
        class: Some("combat".into()),
        url: Some("http://example.org:5000/sound".into()),
    }),
);

Fields

fname: S

File name. May contain wildcards. If no extension is specified, “.wav” should be assumed.

volume: u8

Volume between 0 and 100.

repeat: AudioRepetition

Repeat behavior.

priority: u8

This parameter applies when some sound is playing and another request arrives. Then, if new request has higher (but NOT equal) priority than the one that’s currently being played, old sound must be stopped and the new sound starts playing instead. In the case of a tie, the sound that is already playing wins.

class: Option<S>

Type of sound, e.g. combat, zone, death, clan. Case-insensitive. This parameter was intended to provide a way to group sounds into subfolders within the main sound directory.

url: Option<S>

Specifies the URL of the sound file. This allows downloading files from the MUD server. Client should always look in local directories first, and only download the file if it’s not available locally.

Implementations

impl<S: AsRef<str>> Sound<S>

pub fn is_off(&self) -> bool

Returns true if this command is a <SOUND OFF> command, causing sounds to stop rather than triggering a sound.

impl<S> Sound<S>

pub fn map_text<T, F>(self, f: F) -> Sound<T>

where F: FnMut(S) -> T,

Applies a type transformation to all text, returning a new struct.

impl<S: IntoOwnedString> Sound<S>

pub fn into_owned(self) -> Sound<String>

impl<S: AsRef<str>> Sound<S>

pub fn borrow_text(&self) -> Sound<&str>

Returns a new struct that borrows text from this one.

Trait Implementations

impl<S: Clone> Clone for Sound<S>

fn clone(&self) -> Sound<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Sound<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for Sound<S>

fn default() -> Self

Returns the “default value” for a type.

impl<S: AsRef<str>> Display for Sound<S>

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

Formats the value using the given formatter.

impl FromStr for Sound

type Err = FromStrError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<Sound<&str>> for Sound<String>

fn eq(&self, other: &Sound<&str>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Sound<&str>> for Sound<Cow<'_, str>>

fn eq(&self, other: &Sound<&str>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Sound<Cow<'_, str>>> for Sound<String>

fn eq(&self, other: &Sound<Cow<'_, str>>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Sound<Cow<'_, str>>> for Sound<&str>

fn eq(&self, other: &Sound<Cow<'_, str>>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Sound> for Sound<&str>

fn eq(&self, other: &Sound<String>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Sound> for Sound<Cow<'_, str>>

fn eq(&self, other: &Sound<String>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: PartialEq> PartialEq for Sound<S>

fn eq(&self, other: &Sound<S>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> TryFrom<&'a str> for Sound<Cow<'a, str>>

type Error = FromStrError

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<S: Copy> Copy for Sound<S>

impl<S: Eq> Eq for Sound<S>

impl<S> StructuralPartialEq for Sound<S>