Struct ruma::events::audio::Amplitude

pub struct Amplitude(_);

Available on crate features events and unstable-msc3246 only.

The amplitude of a waveform sample.

Must be an integer between 0 and 1024.

Implementations

impl Amplitude

pub const MIN: u16 = 0u16

The smallest value that can be represented by this type, 0.

pub const MAX: u16 = 1_024u16

The largest value that can be represented by this type, 1024.

pub fn new(value: u16) -> Amplitude

Creates a new Amplitude with the given value.

It will saturate if it is bigger than Amplitude::MAX.

pub fn get(&self) -> UInt

The value of this Amplitude.

Trait Implementations

impl Clone for Amplitude

fn clone(&self) -> Amplitude

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Amplitude

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

Formats the value using the given formatter.

impl Default for Amplitude

fn default() -> Amplitude

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Amplitude

fn deserialize<D>(
    deserializer: D
) -> Result<Amplitude, <D as Deserializer<'de>>::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<u16> for Amplitude

fn from(value: u16) -> Amplitude

Converts to this type from the input type.

impl Hash for Amplitude

fn hash<__H>(&self, state: &mut __H)where
    __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Amplitude

fn cmp(&self, other: &Amplitude) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Amplitude> for Amplitude

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<Amplitude> for Amplitude

fn partial_cmp(&self, other: &Amplitude) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Amplitude

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

Serialize this value into the given Serde serializer.

impl Copy for Amplitude

impl Eq for Amplitude

impl StructuralEq for Amplitude

impl StructuralPartialEq for Amplitude