Struct TimeDelta

pub struct TimeDelta { /* private fields */ }

Represents a duration between two TimePoints.

Implementations

impl TimeDelta

pub fn from_components(hours: i64, mins: i64, secs: i64, ms: i64) -> TimeDelta

Create this time type from all time components.

The components can be negative and/or exceed the its natural limits without error. For example from_components(0, 0, 3, -2000) is the same as from_components(0, 0, 1, 0).

pub fn from_msecs(ms: i64) -> TimeDelta

Create the time type from a given number of milliseconds.

pub fn from_csecs(ms: i64) -> TimeDelta

Create the time type from a given number of hundreth seconds (10 milliseconds).

pub fn from_secs(ms: i64) -> TimeDelta

Create the time type with a given number of seconds.

pub fn from_mins(mins: i64) -> TimeDelta

Create the time type with a given number of minutes.

Examples found in repository

examples/example1.rs (line 28)

fn main() {
    // your setup goes here
    let path = PathBuf::from("path/your_example_file.ssa");
    let file_content: String = read_file(&path); // your own load routine

    // parse the file
    let format = get_subtitle_format(path.extension(), file_content.as_bytes()).expect("unknown format");
    let mut subtitle_file = parse_str(format, &file_content, 25.0).expect("parser error");
    let mut subtitle_entries: Vec<SubtitleEntry> = subtitle_file.get_subtitle_entries().expect("unexpected error");

    // shift all subtitle entries by 1 minute and append "subparse" to each subtitle line
    for subtitle_entry in &mut subtitle_entries {
        subtitle_entry.timespan += TimeDelta::from_mins(1);

        // image based subtitles like .idx (VobSub) don't have text, so
        // a text is optional
        if let Some(ref mut line_ref) = subtitle_entry.line {
            line_ref.push_str("subparse");
        }
    }

    // update the entries in the subtitle file
    subtitle_file.update_subtitle_entries(&subtitle_entries).expect("unexpected error");

    // print the corrected file to stdout
    let data: Vec<u8> = subtitle_file.to_data().expect("unexpected errror");
    let data_string = String::from_utf8(data).expect("UTF-8 conversion error");
    println!("{}", data_string);
}

pub fn from_hours(mins: i64) -> TimeDelta

Create the time type with a given number of hours.

pub fn msecs(&self) -> i64

Get the total number of milliseconds.

pub fn csecs(&self) -> i64

Get the total number of hundreth seconds.

pub fn secs(&self) -> i64

Get the total number of seconds.

pub fn secs_f64(&self) -> f64

Get the total number of seconds.

pub fn mins(&self) -> i64

Get the total number of seconds.

pub fn hours(&self) -> i64

Get the total number of hours.

pub fn msecs_comp(&self) -> i64

Get the milliseconds component in a range of [0, 999].

pub fn csecs_comp(&self) -> i64

Get the hundreths seconds component in a range of [0, 99].

pub fn secs_comp(&self) -> i64

Get the seconds component in a range of [0, 59].

pub fn mins_comp(&self) -> i64

Get the minute component in a range of [0, 59].

pub fn is_negative(&self) -> bool

Return true if the represented time is negative.

pub fn abs(&self) -> TimeDelta

Return the absolute value of the current time.

Trait Implementations

impl Add<TimeDelta> for TimePoint

type Output = TimePoint

The resulting type after applying the + operator.

fn add(self, rhs: TimeDelta) -> TimePoint

Performs the + operation.

impl Add<TimeDelta> for TimeSpan

type Output = TimeSpan

The resulting type after applying the + operator.

fn add(self, rhs: TimeDelta) -> TimeSpan

Performs the + operation.

impl Add<TimePoint> for TimeDelta

type Output = TimePoint

The resulting type after applying the + operator.

fn add(self, rhs: TimePoint) -> TimePoint

Performs the + operation.

impl Add for TimeDelta

type Output = TimeDelta

The resulting type after applying the + operator.

fn add(self, rhs: TimeDelta) -> TimeDelta

Performs the + operation.

impl AddAssign<TimeDelta> for TimePoint

fn add_assign(&mut self, r: TimeDelta)

Performs the += operation.

impl AddAssign<TimeDelta> for TimeSpan

fn add_assign(&mut self, r: TimeDelta)

Performs the += operation.

impl AddAssign for TimeDelta

fn add_assign(&mut self, r: TimeDelta)

Performs the += operation.

impl Clone for TimeDelta

fn clone(&self) -> TimeDelta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeDelta

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

Formats the value using the given formatter.

impl Display for TimeDelta

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

Formats the value using the given formatter.

impl Hash for TimeDelta

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Neg for TimeDelta

type Output = TimeDelta

The resulting type after applying the - operator.

fn neg(self) -> TimeDelta

Performs the unary - operation.

impl Ord for TimeDelta

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

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

fn partial_cmp(&self, other: &TimeDelta) -> 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 Sub<TimeDelta> for TimePoint

type Output = TimePoint

The resulting type after applying the - operator.

fn sub(self, rhs: TimeDelta) -> TimePoint

Performs the - operation.

impl Sub<TimeDelta> for TimeSpan

type Output = TimeSpan

The resulting type after applying the - operator.

fn sub(self, rhs: TimeDelta) -> TimeSpan

Performs the - operation.

impl Sub<TimePoint> for TimeDelta

type Output = TimePoint

The resulting type after applying the - operator.

fn sub(self, rhs: TimePoint) -> TimePoint

Performs the - operation.

impl Sub for TimeDelta

type Output = TimeDelta

The resulting type after applying the - operator.

fn sub(self, rhs: TimeDelta) -> TimeDelta

Performs the - operation.

impl SubAssign<TimeDelta> for TimePoint

fn sub_assign(&mut self, r: TimeDelta)

Performs the -= operation.

impl SubAssign<TimeDelta> for TimeSpan

fn sub_assign(&mut self, r: TimeDelta)

Performs the -= operation.

impl SubAssign for TimeDelta

fn sub_assign(&mut self, r: TimeDelta)

Performs the -= operation.

impl Copy for TimeDelta

impl Eq for TimeDelta

impl StructuralPartialEq for TimeDelta