Struct InstantSamples 

#[repr(transparent)]
pub struct InstantSamples(pub i64);

An absolute audio clock instant in units of samples (in a single channel of audio).

Tuple Fields

0: i64

Implementations

impl InstantSamples

pub const ZERO: Self

pub const MAX: Self

pub const fn new(samples: i64) -> Self

pub fn whole_seconds_and_fract(&self, sample_rate: NonZeroU32) -> (i64, u32)

(whole seconds, samples after whole seconds)

pub fn fract_second_samples(&self, sample_rate: NonZeroU32) -> u32

pub fn to_seconds( self, sample_rate: NonZeroU32, sample_rate_recip: f64, ) -> InstantSeconds

pub fn to_musical( self, transport: &MusicalTransport, transport_start: InstantSamples, speed_multiplier: f64, sample_rate: NonZeroU32, sample_rate_recip: f64, ) -> InstantMusical

Convert to the corresponding musical time.

pub const fn duration_since(&self, earlier: Self) -> DurationSamples

Returns the amount of time elapsed from another instant to this one.

If earlier is later than this one, then the returned value will be negative.

pub fn checked_duration_since(&self, earlier: Self) -> Option<DurationSamples>

Returns the amount of time elapsed from another instant to this one, or `None`` if that instant is later than this one.

pub fn saturating_duration_since(&self, earlier: Self) -> DurationSamples

Returns the amount of time elapsed from another instant to this one, or zero` if that instant is later than this one.

Trait Implementations

impl Add<DurationSamples> for InstantSamples

type Output = InstantSamples

The resulting type after applying the + operator.

fn add(self, rhs: DurationSamples) -> Self::Output

Performs the + operation.

impl AddAssign<DurationSamples> for InstantSamples

fn add_assign(&mut self, rhs: DurationSamples)

Performs the += operation.

impl Clone for InstantSamples

fn clone(&self) -> InstantSamples

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstantSamples

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

Formats the value using the given formatter.

impl Default for InstantSamples

fn default() -> InstantSamples

Returns the “default value” for a type.

impl Diff for InstantSamples

fn diff<E: EventQueue>( &self, baseline: &Self, path: PathBuilder, event_queue: &mut E, )

Compare self to baseline and generate events to resolve any differences.

impl From<InstantSamples> for EventInstant

fn from(value: InstantSamples) -> Self

Converts to this type from the input type.

impl From<InstantSamples> for ParamData

fn from(value: InstantSamples) -> Self

Converts to this type from the input type.

impl From<InstantSamples> for i64

fn from(value: InstantSamples) -> Self

Converts to this type from the input type.

impl From<i64> for InstantSamples

fn from(value: i64) -> Self

Converts to this type from the input type.

impl FromReflect for InstantSamples

where InstantSamples: Any + Send + Sync, i64: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for InstantSamples

where InstantSamples: Any + Send + Sync, i64: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Hash for InstantSamples

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 Ord for InstantSamples

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for InstantSamples

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

fn partial_cmp(&self, other: &InstantSamples) -> 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 PartialReflect for InstantSamples

where InstantSamples: Any + Send + Sync, i64: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Patch for InstantSamples

type Patch = InstantSamples

A type’s patch.

fn patch(data: &ParamData, _: &[u32]) -> Result<Self::Patch, PatchError>

Construct a patch from a parameter event.

fn apply(&mut self, value: Self::Patch)

Apply a patch.

fn patch_event(event: &NodeEventType) -> Option<Self::Patch>

Construct a patch from a node event.

impl Reflect for InstantSamples

where InstantSamples: Any + Send + Sync, i64: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Sub<DurationSamples> for InstantSamples

type Output = InstantSamples

The resulting type after applying the - operator.

fn sub(self, rhs: DurationSamples) -> Self::Output

Performs the - operation.

impl Sub for InstantSamples

type Output = DurationSamples

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign<DurationSamples> for InstantSamples

fn sub_assign(&mut self, rhs: DurationSamples)

Performs the -= operation.

impl TryInto<InstantSamples> for &ParamData

type Error = PatchError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<InstantSamples, PatchError>

Performs the conversion.

impl TupleStruct for InstantSamples

where InstantSamples: Any + Send + Sync, i64: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

fn iter_fields(&self) -> TupleStructFieldIter<'_>

Returns an iterator over the values of the tuple struct’s fields.

fn to_dynamic_tuple_struct(&self) -> DynamicTupleStruct

Creates a new DynamicTupleStruct from this tuple struct.

fn clone_dynamic(&self) -> DynamicTupleStruct

👎Deprecated since 0.16.0: use to_dynamic_tuple_struct instead

Clones the struct into a DynamicTupleStruct.

fn get_represented_tuple_struct_info(&self) -> Option<&'static TupleStructInfo>

Will return None if TypeInfo is not available.

impl TypePath for InstantSamples

where InstantSamples: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for InstantSamples

where InstantSamples: Any + Send + Sync, i64: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for InstantSamples

impl Eq for InstantSamples

impl StructuralPartialEq for InstantSamples