Struct FrameOffset 

pub struct FrameOffset { /* private fields */ }

Absolute frame offset from the epoch (midnight).

Implementations

impl FrameOffset

pub fn new(frames: u64) -> Self

Create a new frame offset.

pub fn as_frames(&self) -> u64

Get the raw frame count.

pub fn add_frames(self, n: u64) -> Self

Add a number of frames.

pub fn sub_frames(self, n: u64) -> Self

Subtract frames, saturating at zero.

pub fn diff(self, other: FrameOffset) -> i64

Compute the difference in frames.

pub fn to_timecode( self, frame_rate: FrameRate, ) -> Result<Timecode, TimecodeError>

Convert to a timecode at the given frame rate.

pub fn to_seconds(self, frame_rate: FrameRate) -> f64

Convert to wall-clock time in seconds.

pub fn from_seconds(seconds: f64, frame_rate: FrameRate) -> Self

Create from wall-clock time in seconds.

pub fn from_timecode(tc: &Timecode) -> Self

Create from a timecode.

Trait Implementations

impl Clone for FrameOffset

fn clone(&self) -> FrameOffset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameOffset

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

Formats the value using the given formatter.

impl From<u64> for FrameOffset

fn from(n: u64) -> Self

Converts to this type from the input type.

impl Ord for FrameOffset

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

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

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

impl Eq for FrameOffset

impl StructuralPartialEq for FrameOffset