Struct srtlib::Subtitle

pub struct Subtitle {
    pub num: usize,
    pub start_time: Timestamp,
    pub end_time: Timestamp,
    pub text: String,
}

A single subtitle.

Contains the numeric counter, the beginning and end timestamps and the text of the subtitle.

Examples

use srtlib::Subtitle;
use srtlib::Timestamp;

let sub = Subtitle::new(1, Timestamp::new(0, 0, 0, 0), Timestamp::new(0, 0, 1, 0), "Hello world".to_string());
assert_eq!(sub.to_string(), "1\n00:00:00,000 --> 00:00:01,000\nHello world");

let sub = Subtitle::parse("2\n00:00:01,500 --> 00:00:02,500\nFooBar".to_string()).unwrap();
assert_eq!(sub.text, "FooBar");

Fields

num: usize

start_time: Timestamp

end_time: Timestamp

text: String

Implementations

impl Subtitle

pub fn new(
    num: usize,
    start_time: Timestamp,
    end_time: Timestamp,
    text: String
) -> Subtitle

Constructs a new Subtitle.

pub fn parse(input: String) -> Result<Subtitle, ParsingError>

Construct a new subtitle by parsing a string with the format "num\nstart --> end\ntext" where start and end are timestamps using the format hours:minutes:seconds,milliseconds.

Errors

If this function encounters anything unexpected while parsing the string, a corresponding error variant will be returned.

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

Moves the start and end timestamps n hours forward in time. Negative values may be provided in order to move the timestamps 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 start and end timestamps n minutes forward in time. Negative values may be provided in order to move the timestamps 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 start and end timestamps n seconds forward in time. Negative values may be provided in order to move the timestamps 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 start and end timestamps n milliseconds forward in time. Negative values may be provided in order to move the timestamps back in time.

Panics

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

Trait Implementations

impl Debug for Subtitle

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

Formats the value using the given formatter.

impl Display for Subtitle

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

Formats the value using the given formatter.

impl Eq for Subtitle

impl Hash for Subtitle

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 Subtitle

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

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

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

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

This method tests for !=.

impl PartialOrd<Subtitle> for Subtitle

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Subtitle

impl StructuralPartialEq for Subtitle