Skip to main content

TimecodeLog

Struct TimecodeLog 

Source
pub struct TimecodeLog {
    pub name: String,
    /* private fields */
}
Expand description

Production timecode log.

A sorted list of LogEntry values that can be recorded, queried, and exported in various formats.

Fields§

§name: String

Log name / production title.

Implementations§

Source§

impl TimecodeLog

Source

pub fn new(name: impl Into<String>) -> Self

Create a new empty log.

Source

pub fn record( &mut self, timecode: Timecode, level: LogLevel, message: impl Into<String>, )

Record a new entry.

Source

pub fn insert(&mut self, entry: LogEntry)

Insert a pre-constructed entry in sorted order.

Source

pub fn query(&self, filter: &LogFilter) -> Vec<&LogEntry>

Return all entries matching the given filter.

Source

pub fn all_entries(&self) -> &[LogEntry]

Return all entries.

Source

pub fn len(&self) -> usize

Number of entries.

Source

pub fn is_empty(&self) -> bool

Whether the log is empty.

Source

pub fn clear(&mut self)

Remove all entries.

Source

pub fn to_text(&self) -> String

Export as plain-text log.

Source

pub fn to_csv(&self) -> String

Export as CSV (timecode, level, category, message).

Source

pub fn first_at_or_after(&self, tc: &Timecode) -> Option<&LogEntry>

Find the first entry at or after the given timecode.

Source

pub fn entries_in_range( &self, start: &Timecode, end: &Timecode, ) -> Vec<&LogEntry>

Find all entries within a timecode range (inclusive).

Source

pub fn from_csv( name: impl Into<String>, csv: &str, frame_rate: FrameRate, ) -> Result<Self, TimecodeError>

Parse from CSV text (inverse of to_csv).

§Errors

Returns error if a line has invalid timecode format.

Trait Implementations§

Source§

impl Debug for TimecodeLog

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.