Struct srtlib::Timestamp

pub struct Timestamp { /* fields omitted */ }

A simple timestamp following the timecode format hours:minutes:seconds,milliseconds.

Used within the Subtitle struct to indicate the time that the subtitle should appear on screen(start_time) and the time it should disappear(end_time). The maximum value for any given Timestamp is 255:59:59,999.

Examples

We can directly construct Timestamps from integers and they will always be displayed with the correct timecode format:

use srtlib::Timestamp;

let time = Timestamp::new(0, 0, 1, 200);
assert_eq!(time.to_string(), "00:00:01,200");

We can also, for example, construct the Timestamp by parsing a string, move it forward in time by 65 seconds and then print it in the correct format.

use srtlib::Timestamp;

let mut time = Timestamp::parse("00:01:10,314").unwrap();
time.add_seconds(65);
assert_eq!(time.to_string(), "00:02:15,314");

Implementations

impl Timestamp

pub fn new(hours: u8, minutes: u8, seconds: u8, milliseconds: u16) -> Timestamp

Constructs a new Timestamp from integers.

pub fn parse(s: &str) -> Result<Timestamp, ParsingError>

Constructs a new Timestamp by parsing a string with the format "hours:minutes:seconds,milliseconds".

Errors

If this function encounters a string that does not follow the correct timecode format, a MalformedTimestamp error variant will be returned.

pub fn add_hours(&mut self, n: i32)

Moves the timestamp n hours forward in time. Negative values may be provided in order to move the timestamp back in time.

Panics

Panics if we exceed the upper limit or go below zero.

pub fn add_minutes(&mut self, n: i32)

Moves the timestamp n minutes forward in time. Negative values may be provided in order to move the timestamp back in time.

Panics

Panics if we exceed the upper limit or go below zero.

pub fn add_seconds(&mut self, n: i32)

Moves the timestamp n seconds forward in time. Negative values may be provided in order to move the timestamp back in time.

Panics

Panics if we exceed the upper limit or go below zero.

pub fn add_milliseconds(&mut self, n: i32)

Moves the timestamp n milliseconds forward in time. Negative values may be provided in order to move the timestamp back in time.

Panics

Panics if we exceed the upper limit or go below zero.

pub fn get(&self) -> (u8, u8, u8, u16)

Returns the timestamp as a tuple of four integers (hours, minutes, seconds, milliseconds).

pub fn set(&mut self, hours: u8, minutes: u8, seconds: u8, milliseconds: u16)

Changes the timestamp according to the given integer values.

Trait Implementations

impl Clone for Timestamp

fn clone(&self) -> Timestamp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Timestamp

impl Debug for Timestamp

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

Formats the value using the given formatter.

impl Display for Timestamp

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

Formats the value using the given formatter.

impl Eq for Timestamp

impl Hash for Timestamp

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Timestamp

fn cmp(&self, other: &Timestamp) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Timestamp> for Timestamp

fn eq(&self, other: &Timestamp) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Timestamp) -> bool

This method tests for !=.

impl PartialOrd<Timestamp> for Timestamp

fn partial_cmp(&self, other: &Timestamp) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Timestamp) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Timestamp) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Timestamp) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Timestamp) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Timestamp

impl StructuralPartialEq for Timestamp