Struct reaper_medium::PositionInSeconds

#[repr(transparent)]
pub struct PositionInSeconds(_);

This represents a position expressed as amount of seconds.

Sometimes this is a negative number, e.g. when it’s a position on the timeline and a metronome count-in is used or at the very beginning of the project (maybe because of rounding). Negative project start values don’t seem to cause negative position values though.

Implementations

impl PositionInSeconds

pub const ZERO: PositionInSeconds = _

Position at 0.0 seconds. E.g. start of project, measure, etc. depending on the context.

pub fn new(value: f64) -> PositionInSeconds

Creates a value.

Panics

This function panics if the given value is a special number.

pub unsafe fn new_unchecked(value: f64) -> PositionInSeconds

Creates a PositionInSeconds value without bound checking.

Safety

You must ensure that the given value is a non-special number.

pub const fn get(self) -> f64

Returns the wrapped value.

pub fn rem_euclid(self, rhs: DurationInSeconds) -> DurationInSeconds

See f64::rem_euclid.

pub fn abs(self) -> DurationInSeconds

Computes the absolute value, returning a duration.

Trait Implementations

impl Add<DurationInSeconds> for PositionInSeconds

type Output = PositionInSeconds

The resulting type after applying the + operator.

fn add(self, rhs: DurationInSeconds) -> Self

Performs the + operation.

impl Add<PositionInSeconds> for PositionInSeconds

type Output = PositionInSeconds

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f64> for PositionInSeconds

type Output = PositionInSeconds

The resulting type after applying the + operator.

fn add(self, rhs: f64) -> Self

Performs the + operation.

impl Clone for PositionInSeconds

fn clone(&self) -> PositionInSeconds

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PositionInSeconds

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

Formats the value using the given formatter.

impl Default for PositionInSeconds

fn default() -> PositionInSeconds

Returns the “default value” for a type.

impl Display for PositionInSeconds

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

Formats the value using the given formatter.

impl Div<DurationInSeconds> for PositionInSeconds

type Output = PositionInSeconds

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<DurationInSeconds> for PositionInSeconds

fn from(v: DurationInSeconds) -> Self

Converts to this type from the input type.

impl Mul<f64> for PositionInSeconds

type Output = PositionInSeconds

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self

Performs the * operation.

impl Neg for PositionInSeconds

type Output = PositionInSeconds

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for PositionInSeconds

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<DurationInSeconds> for PositionInSeconds

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

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

const 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 PartialEq<PositionInSeconds> for PositionInSeconds

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

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

const 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<DurationInSeconds> for PositionInSeconds

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

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

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

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

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

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

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

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

const 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 PartialOrd<PositionInSeconds> for PositionInSeconds

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

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

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

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

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

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

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

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

const 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 Rem<DurationInSeconds> for PositionInSeconds

type Output = Option<PositionInSeconds>

The resulting type after applying the % operator.

fn rem(self, rhs: DurationInSeconds) -> Option<Self>

Performs the % operation.

impl Sub<DurationInSeconds> for PositionInSeconds

type Output = PositionInSeconds

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<PositionInSeconds> for PositionInSeconds

type Output = PositionInSeconds

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f64> for PositionInSeconds

type Output = PositionInSeconds

The resulting type after applying the - operator.

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

Performs the - operation.

impl TryFrom<PositionInSeconds> for DurationInSeconds

type Error = TryFromGreaterError<f64>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<f64> for PositionInSeconds

type Error = TryFromGreaterError<f64>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for PositionInSeconds

impl Eq for PositionInSeconds

impl StructuralPartialEq for PositionInSeconds