Struct FrameIndex 

pub struct FrameIndex<T>(/* private fields */);

Represents a frame index.

Implementations

impl<T> FrameIndex<T>

pub fn new(value: T) -> Self

Creates a new FrameIndex from the given value.

pub const fn index(&self) -> T

where T: Copy,

Returns the raw frame value.

pub fn into_index(self) -> T

Consumes this FrameIndex value and returns the inner frame value.

pub fn from_time<S>(time: Time<S>, rate: FrameRate<S>) -> Self

where S: Copy + Mul<Output = S> + Floor + SaturatingCast<T>,

Creates a FrameIndex from Time at the specified FrameRate.

pub fn to_time<S>(self, rate: FrameRate<S>) -> Time<S>

where T: Copy + LossyCast<S>, S: Copy + Div<Output = S>,

Converts this FrameIndex to Time at the specified FrameRate.

pub fn offset_from(self, other: Self) -> <T as SignedEquivalent>::Signed

where T: SignedEquivalent + SignedCast<<T as SignedEquivalent>::Signed>, <T as SignedEquivalent>::Signed: Sub<Output = <T as SignedEquivalent>::Signed>,

Returns the signed frame offset from this index to another index. The result is positive when self is ahead of other, negative when behind, and zero when equal.

pub fn next(&self) -> Self

where T: One + SaturatingAdd<Output = T>, Self: Copy + SaturatingAdd<T, Output = Self>,

Returns the next FrameIndex, saturating at T::MAX.

pub fn previous(&self) -> Self

where T: One + SaturatingSub<Output = T>, Self: Copy + SaturatingSub<T, Output = Self>,

Returns the previous FrameIndex, saturating at T::MIN.

impl<T> FrameIndex<T>

where T: Zero,

pub const ZERO: Self

Returns the zero.

impl<T> FrameIndex<T>

where T: BoundedMin,

pub const MIN: Self

Returns the minimum value.

impl<T> FrameIndex<T>

where T: BoundedMax,

pub const MAX: Self

Returns the maximum value.

impl<T> FrameIndex<T>

where T: MinMax,

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

Returns the minimum of two values.

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

Returns the maximum of two values.

impl<T> FrameIndex<T>

where T: SaturatingAdd<Output = T>,

pub fn saturating_add(self, rhs: Self) -> Self

Returns the result of saturating addition of two FrameIndex values.

pub fn saturating_add_t(self, rhs: T) -> Self

Returns the result of saturating addition of a FrameIndex value and a raw frame value.

impl<T> FrameIndex<T>

where T: SaturatingSub<Output = T>,

pub fn saturating_sub(self, rhs: Self) -> Self

Returns the result of saturating subtraction of two FrameIndex values.

pub fn saturating_sub_t(self, rhs: T) -> Self

Returns the result of saturating subtraction of a FrameIndex value and a raw frame value.

Trait Implementations

impl<T> Add for FrameIndex<T>

where T: Add<Output = T>,

type Output = FrameIndex<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add<T> for FrameIndex<T>

where T: Add<Output = T>,

type Output = FrameIndex<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign for FrameIndex<T>

where T: AddAssign,

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T> AddAssign<T> for FrameIndex<T>

where T: AddAssign,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<T> ApproxEqAbs for FrameIndex<T>

where T: Copy + ApproxEqAbs<Tolerance = T>,

const DEFAULT_TOLERANCE_ABS: Self::Tolerance = <T as ::rinia::algebra::ApproxEqAbs>::DEFAULT_TOLERANCE_ABS

The default absolute tolerance for approximate equality checks.

type Tolerance = T

The type of the tolerance used for absolute approximate equality checks.

fn approx_eq_abs_tol(self, other: Self, tol: Self::Tolerance) -> bool

Checks if the value is approximately equal to another value within a given absolute tolerance.

fn approx_eq_abs(self, other: Rhs) -> bool

where Self: Sized,

Checks if the value is approximately equal to another value within the default absolute tolerance.

impl<T> ApproxEqRel for FrameIndex<T>

where T: Copy + ApproxEqRel<Tolerance = T>,

const DEFAULT_TOLERANCE_REL: Self::Tolerance = <T as ::rinia::algebra::ApproxEqRel>::DEFAULT_TOLERANCE_REL

The default relative tolerance for approximate equality checks.

type Tolerance = T

The type of the tolerance used for relative approximate equality checks.

fn approx_eq_rel_tol(self, other: Self, tol: Self::Tolerance) -> bool

Checks if the value is approximately equal to another value within a given relative tolerance.

fn approx_eq_rel(self, other: Rhs) -> bool

where Self: Sized,

Checks if the value is approximately equal to another value within the default relative tolerance.

impl<T> BoundedMax for FrameIndex<T>

where T: BoundedMax,

const MAX: Self = FrameIndex::MAX

The maximum value of the type.

impl<T> BoundedMin for FrameIndex<T>

where T: BoundedMin,

const MIN: Self = FrameIndex::MIN

The minimum value of the type.

impl<T: Clone> Clone for FrameIndex<T>

fn clone(&self) -> FrameIndex<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for FrameIndex<T>

impl<T: Debug> Debug for FrameIndex<T>

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

Formats the value using the given formatter.

impl<T> Default for FrameIndex<T>

where Self: Zero,

fn default() -> Self

Returns the “default value” for a type.

impl From<FrameIndex<u32>> for u32

fn from(frame: FrameIndex<u32>) -> Self

Converts to this type from the input type.

impl From<FrameIndex<u64>> for u64

fn from(frame: FrameIndex<u64>) -> Self

Converts to this type from the input type.

impl From<FrameIndex<usize>> for usize

fn from(frame: FrameIndex<usize>) -> Self

Converts to this type from the input type.

impl<T> From<T> for FrameIndex<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T> MinMax for FrameIndex<T>

where T: MinMax,

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

Computes the minimum of two values.

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

Computes the maximum of two values.

impl<T: PartialEq> PartialEq for FrameIndex<T>

fn eq(&self, other: &FrameIndex<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd> PartialOrd for FrameIndex<T>

fn partial_cmp(&self, other: &FrameIndex<T>) -> 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<T> SaturatingAdd for FrameIndex<T>

where T: SaturatingAdd<Output = T>,

type Output = FrameIndex<T>

The output type for the saturating addition.

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

Performs saturating addition of self and rhs.

impl<T> SaturatingAdd<T> for FrameIndex<T>

where T: SaturatingAdd<Output = T>,

type Output = FrameIndex<T>

The output type for the saturating addition.

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

Performs saturating addition of self and rhs.

impl<T> SaturatingSub for FrameIndex<T>

where T: SaturatingSub<Output = T>,

type Output = FrameIndex<T>

The output type for the saturating subtraction.

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

Performs saturating subtraction of self and rhs.

impl<T> SaturatingSub<T> for FrameIndex<T>

where T: SaturatingSub<Output = T>,

type Output = FrameIndex<T>

The output type for the saturating subtraction.

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

Performs saturating subtraction of self and rhs.

impl<T: PartialEq> StructuralPartialEq for FrameIndex<T>

impl<T> Sub for FrameIndex<T>

where T: Sub<Output = T>,

type Output = FrameIndex<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub<T> for FrameIndex<T>

where T: Sub<Output = T>,

type Output = FrameIndex<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign for FrameIndex<T>

where T: SubAssign,

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<T> SubAssign<T> for FrameIndex<T>

where T: SubAssign,

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<T> Zero for FrameIndex<T>

where T: Zero,

const ZERO: Self = FrameIndex::ZERO

The zero constant for the type.