Struct audio_time::Bytes

#[repr(transparent)]
pub struct Bytes<const SYS: System>(_);

An audio time span, measured in the number of bytes required for its representation.

The usize contained in this struct is invariantly held to be divisible (without remainder) by the size of a single sample (SYS.sample_size()).

Implementations

impl<const SYS: System> Bytes<SYS>

pub const fn new(n: usize) -> Option<Self>

Create a Bytes if the given value is divisible by SYS.sample_size().

pub const fn get(&self) -> usize

impl<const SYS: System> Bytes<SYS>

pub const fn into_duration(self) -> Duration

Equivalent to Duration::try_from(bytes).unwrap().

pub const fn from_duration(dur: Duration) -> Self

Equivalent to Bytes::try_from(duration).unwrap().

pub const fn into_samples(self) -> Samples<SYS>

Equivalent to Samples::from(bytes).

pub const fn from_samples(samples: Samples<SYS>) -> Self

Equivalent to Bytes::try_from(samples).unwrap().

Trait Implementations

impl<const SYS: System> Clone for Bytes<SYS>

fn clone(&self) -> Bytes<SYS>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const SYS: System> Debug for Bytes<SYS>

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

Formats the value using the given formatter.

impl<const SYS: System> Display for Bytes<SYS>

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

Formats the value using the given formatter.

impl<const SYS: System> From<Bytes<SYS>> for Samples<SYS>

const fn from(value: Bytes<SYS>) -> Self

Converts to this type from the input type.

impl<const SYS: System> From<Bytes<SYS>> for usize

const fn from(value: Bytes<SYS>) -> Self

Converts to this type from the input type.

impl<const SYS: System> Hash for Bytes<SYS>

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

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<const SYS: System> Ord for Bytes<SYS>

fn cmp(&self, other: &Bytes<SYS>) -> 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<const SYS: System> PartialEq<Bytes<SYS>> for Bytes<SYS>

fn eq(&self, other: &Bytes<SYS>) -> 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<const SYS: System> PartialOrd<Bytes<SYS>> for Bytes<SYS>

fn partial_cmp(&self, other: &Bytes<SYS>) -> 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<const SYS: System> TryFrom<Bytes<SYS>> for Duration

type Error = OverflowError

The type returned in the event of a conversion error.

const fn try_from(value: Bytes<SYS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const SYS: System> TryFrom<Duration> for Bytes<SYS>

type Error = OverflowError

The type returned in the event of a conversion error.

const fn try_from(value: Duration) -> Result<Self, Self::Error>

Performs the conversion.

impl<const SYS: System> TryFrom<Samples<SYS>> for Bytes<SYS>

type Error = OverflowError

The type returned in the event of a conversion error.

const fn try_from(value: Samples<SYS>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const SYS: System> Copy for Bytes<SYS>

impl<const SYS: System> Eq for Bytes<SYS>

impl<const SYS: System> StructuralEq for Bytes<SYS>

impl<const SYS: System> StructuralPartialEq for Bytes<SYS>