Struct Timecode 

pub struct Timecode {
    pub hours: u8,
    pub minutes: u8,
    pub seconds: u8,
    pub frames: u8,
    pub frame_rate: FrameRateInfo,
    pub user_bits: u32,
    /* private fields */
}

SMPTE timecode structure

The frame_count_cache field stores the pre-computed total frame count from midnight, avoiding recomputation on repeated calls to to_frames(). It is excluded from equality comparison and serialization so it does not affect timecode identity or wire format.

Fields

hours: u8

Hours (0-23)

minutes: u8

Minutes (0-59)

seconds: u8

Seconds (0-59)

frames: u8

Frames (0 to frame_rate - 1)

frame_rate: FrameRateInfo

Frame rate

user_bits: u32

User bits (32 bits)

Implementations

impl Timecode

pub fn new( hours: u8, minutes: u8, seconds: u8, frames: u8, frame_rate: FrameRate, ) -> Result<Self, TimecodeError>

Create a new timecode

pub fn from_string( s: &str, frame_rate: FrameRate, ) -> Result<Self, TimecodeError>

Parse a SMPTE timecode string.

Accepts both “HH:MM:SS:FF” (non-drop frame, all colons) and “HH:MM:SS;FF” (drop frame, semicolon before frames).

The frame_rate parameter determines the frame rate; the separator before the frame field determines whether drop-frame validation applies.

Errors

Returns an error if the string format is invalid or component values are out of range.

pub fn from_raw_fields( hours: u8, minutes: u8, seconds: u8, frames: u8, fps: u8, drop_frame: bool, user_bits: u32, ) -> Self

Create a Timecode directly from raw fields without constructor validation.

This is intended for internal use in parsers and codecs where the component values have already been validated by the caller. The frame_count_cache is computed automatically.

pub fn with_user_bits(self, user_bits: u32) -> Self

Create timecode with user bits

pub fn to_frames(&self) -> u64

Convert to total frames since midnight.

Returns the cached value computed at construction time — O(1).

pub fn to_seconds_f64(&self) -> f64

Convert this timecode to elapsed wall-clock seconds as f64.

For pull-down rates (23.976, 29.97, 47.952, 59.94) the exact rational frame rate is used so the result is frame-accurate.

pub fn from_frames( frames: u64, frame_rate: FrameRate, ) -> Result<Self, TimecodeError>

Create from total frames since midnight

pub fn increment(&mut self) -> Result<(), TimecodeError>

Increment by one frame

pub fn decrement(&mut self) -> Result<(), TimecodeError>

Decrement by one frame

Trait Implementations

impl Add<u32> for Timecode

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

Add rhs frames to self, wrapping at a 24-hour boundary.

The result uses the frame rate of self.

type Output = Result<Timecode, TimecodeError>

The resulting type after applying the + operator.

impl Add for Timecode

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

Add two timecodes by summing their total frame counts.

The result uses the frame rate of self. The frame counts wrap at a 24-hour boundary.

type Output = Result<Timecode, TimecodeError>

The resulting type after applying the + operator.

impl Clone for Timecode

fn clone(&self) -> Timecode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Timecode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Timecode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Timecode

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

Formats the value using the given formatter.

impl Ord for Timecode

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

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

fn partial_cmp(&self, other: &Self) -> 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 Serialize for Timecode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Timecode

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

Subtract rhs from self by frame count.

The result uses the frame rate of self. Underflow wraps at a 24-hour boundary.

type Output = Result<Timecode, TimecodeError>

The resulting type after applying the - operator.

impl Copy for Timecode

impl Eq for Timecode