Struct TcRange 

pub struct TcRange { /* private fields */ }

A contiguous range of timecodes defined by an inclusive start and exclusive end.

The range is measured in absolute frame counts for a given frame rate.

Implementations

impl TcRange

pub fn new(start: &Timecode, end: &Timecode) -> Result<Self, TimecodeError>

Creates a new timecode range from two timecodes.

Errors

Returns TimecodeError::InvalidConfiguration if start >= end or frame rate info differs.

pub fn from_frames( start: u64, end: u64, fps: u8, drop_frame: bool, ) -> Result<Self, TimecodeError>

Creates a range from raw frame numbers.

Errors

Returns TimecodeError::InvalidConfiguration if start >= end.

pub fn start_frames(&self) -> u64

Returns the start frame number (inclusive).

pub fn end_frames(&self) -> u64

Returns the end frame number (exclusive).

pub fn duration_frames(&self) -> u64

Returns the duration in frames.

pub fn duration_seconds(&self) -> f64

Returns the duration in seconds.

pub fn contains_frame(&self, frame: u64) -> bool

Checks whether the given frame number falls within this range.

pub fn contains_timecode(&self, tc: &Timecode) -> bool

Checks whether the given timecode falls within this range.

pub fn frame_rate_info(&self) -> FrameRateInfo

Returns the FrameRateInfo associated with this range.

pub fn overlaps(&self, other: &Self) -> bool

Checks whether two ranges overlap.

pub fn overlap_kind(&self, other: &Self) -> OverlapKind

Classifies the overlap between two ranges.

pub fn intersect(&self, other: &Self) -> Option<Self>

Returns the intersection of two ranges, if any.

pub fn union(&self, other: &Self) -> Option<Self>

Merges two ranges into one if they overlap or are adjacent.

pub fn split_at_frame(&self, frame: u64) -> SplitResult

Splits the range at the given frame number.

pub fn offset(&self, delta: i64) -> Result<Self, TimecodeError>

Offsets the range by a signed number of frames.

Errors

Returns an error if the result would be negative.

pub fn frame_iter(&self) -> impl Iterator<Item = u64>

Returns a list of frame numbers in this range.

pub fn extend(&self, head_frames: u64, tail_frames: u64) -> Self

Extends the range by the given number of frames on each side.

pub fn trim(&self, head_frames: u64, tail_frames: u64) -> Option<Self>

Trims the range by the given number of frames on each side.

Returns None if the range would become empty.

Trait Implementations

impl Clone for TcRange

fn clone(&self) -> TcRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TcRange

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

Formats the value using the given formatter.

impl PartialEq for TcRange

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

impl StructuralPartialEq for TcRange