Struct audio_time::Samples

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

An audio time span, measured by the number of samples contained in it.

Implementations

impl<const SYS: System> Samples<SYS>

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

pub const fn get(&self) -> usize

impl<const SYS: System> Samples<SYS>

pub const fn into_duration(self) -> Duration

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

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

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

pub const fn into_bytes(self) -> Bytes<SYS>

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

pub const fn from_bytes(bytes: Bytes<SYS>) -> Self

Equivalent to Samples::from(bytes).

Trait Implementations

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

fn clone(&self) -> Samples<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 Samples<SYS>

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl<const SYS: System> Div<Samples<SYS>> for Samples<SYS>

type Output = Samples<SYS>

The resulting type after applying the / operator.

const fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<const SYS: System, T> Div<T> for Samples<SYS>where usize: Div<T, Output = usize>,

type Output = Samples<SYS>

The resulting type after applying the / operator.

const fn div(self, rhs: T) -> Self::Output

Performs the / operation.

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<Samples<SYS>> for usize

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

Converts to this type from the input type.

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

const fn from(value: usize) -> Self

Converts to this type from the input type.

impl<const SYS: System> Hash for Samples<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> Mul<Samples<SYS>> for Samples<SYS>

type Output = Samples<SYS>

The resulting type after applying the * operator.

const fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<const SYS: System, T> Mul<T> for Samples<SYS>where usize: Mul<T, Output = usize>,

type Output = Samples<SYS>

The resulting type after applying the * operator.

const fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<const SYS: System> Ord for Samples<SYS>

fn cmp(&self, other: &Samples<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<Samples<SYS>> for Samples<SYS>

fn eq(&self, other: &Samples<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<Samples<SYS>> for Samples<SYS>

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

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 Samples<SYS>

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

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

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