Struct TimeDesignation

pub struct TimeDesignation { /* private fields */ }

A time designation is a representation of a non-negative offset of time.

Time designations can be provided in either seconds (s) or milliseconds (ms):

assert_eq!("15s".parse::<TimeDesignation>()?, TimeDesignation::from_millis(15_000.));
assert_eq!("750ms".parse::<TimeDesignation>()?, TimeDesignation::from_millis(750.));
assert_eq!("+0.75s".parse::<TimeDesignation>()?, TimeDesignation::from_millis(750.));

// Fails
assert!("-5s".parse::<TimeDesignation>().is_err());
assert!("5 s".parse::<TimeDesignation>().is_err());
assert!("15sec".parse::<TimeDesignation>().is_err());
assert!("5m".parse::<TimeDesignation>().is_err());

Implementations

impl TimeDesignation

pub fn from_millis(millis: f32) -> Self

Create a TimeDesignation from a set number of milliseconds.

pub fn to_millis(&self) -> f32

Convert this time designation to milliseconds.

Trait Implementations

impl Clone for TimeDesignation

fn clone(&self) -> TimeDesignation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeDesignation

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

Formats the value using the given formatter.

impl Default for TimeDesignation

fn default() -> TimeDesignation

Returns the “default value” for a type.

impl Display for TimeDesignation

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

Formats the value using the given formatter.

impl From<&str> for TimeDesignation

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<TimeDesignation> for ProsodyControl

fn from(rate: TimeDesignation) -> Self

Converts to this type from the input type.

impl FromStr for TimeDesignation

type Err = TimeDesignationError

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 for TimeDesignation

fn eq(&self, other: &TimeDesignation) -> 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 PartialOrd for TimeDesignation

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for TimeDesignation