Struct aspasia::SubRipSubtitle

pub struct SubRipSubtitle { /* private fields */ }

SubRip (.srt) subtitle data, containing only a list of events.

Implementations

impl SubRipSubtitle

pub fn from_events(events: Vec<SubRipEvent>) -> Self

Creates a new SubRip (.srt) subtitle from an already existing list of SubRipEvents

pub fn renumber(&mut self)

Renumbers all events according to the order they are stored in.

This modifies the line number of all events, starting from 1 for the first event and incrementing by 1 for each subsequent event.

Examples found in repository

examples/basic.rs (line 18)

fn main() -> Result<(), Error> {
    // We can directly specify the format to open a subtitle file
    let vtt = WebVttSubtitle::from_path("/path/to/some.vtt")?;

    // and then directly work with its data
    println!("{}", vtt.header().cloned().unwrap_or_default());

    // or we could use the more general interface to open (timed) subtitle files
    let sub = TimedSubtitleFile::new("/path/to/file.srt")?;

    // Move the underlying data out in order to access format-specific properties
    // Note that if the format doesn't match, this will perform a conversion instead of just moving the data
    let mut srt = SubRipSubtitle::from(sub);

    // Now we can access format-specific methods like SubRipSubtitle::renumber()
    srt.renumber();

    // Access and modify events
    for event in srt.events_mut() {
        event.shift(600.into());
    }

    // Write the modified subtitle to file
    srt.export("/path/to/output.srt")?;

    Ok(())
}

Trait Implementations

impl Clone for SubRipSubtitle

fn clone(&self) -> SubRipSubtitle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubRipSubtitle

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

Formats the value using the given formatter.

impl Display for SubRipSubtitle

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

Formats the value using the given formatter.

impl From<&AssSubtitle> for SubRipSubtitle

fn from(value: &AssSubtitle) -> Self

Convert Advanced SubStation Alpha (.ass) subtitles to .srt format

Replaces SubStation newline indicators (\N) with actual newlines. Additionally, converts .ass style formatting tags to .srt formatting tags. Currently, bolded, italicised, underlined, or coloured text will be converted to their .srt counterparts. All other tags will be discarded.

impl From<&SsaSubtitle> for SubRipSubtitle

fn from(value: &SsaSubtitle) -> Self

Convert SubStation Alpha (.ssa) subtitles to .srt format

Replaces SubStation newline indicators (\N) with actual newlines. Additionally, converts .ssa style formatting tags to .srt formatting tags. Currently, bolded, italicised, or coloured text will be converted to their .srt counterparts. All other tags will be discarded.

impl From<&SubRipSubtitle> for AssSubtitle

fn from(value: &SubRipSubtitle) -> Self

Convert SubRip (.srt) subtitle to .ass format.

This will replace newlines and convert HTML formatting tags (<b>, <i>, etc.) into .ass style formatting tags

impl From<&SubRipSubtitle> for SsaSubtitle

fn from(value: &SubRipSubtitle) -> Self

Convert SubRip (.srt) subtitle to .ssa format.

This will replace newlines and convert HTML formatting tags (<b>, <i>, etc.) into .ssa style formatting tags

impl From<&SubRipSubtitle> for TimedMicroDvdSubtitle

fn from(value: &SubRipSubtitle) -> Self

Converts to this type from the input type.

impl From<&SubRipSubtitle> for WebVttSubtitle

fn from(value: &SubRipSubtitle) -> Self

Convert a SubRip (.srt) subtitle to WebVTT format.

This sets the line number as the cue identifier.

The supported tags are <b>, <i>, and <u>. Any other tags will be stripped from the text.

Bracket tags (of the form {b}) will be converted to HTML tags (<b>).

impl From<&TimedMicroDvdSubtitle> for SubRipSubtitle

fn from(value: &TimedMicroDvdSubtitle) -> Self

Converts to this type from the input type.

impl From<&WebVttSubtitle> for SubRipSubtitle

fn from(value: &WebVttSubtitle) -> Self

Convert WebVTT (.vtt) subtitle to .srt format

Cue identifiers that are numbers will be treated as line numbers for the corresponding event in the .srt output.

impl From<AssSubtitle> for SubRipSubtitle

fn from(value: AssSubtitle) -> Self

Converts to this type from the input type.

impl From<PlainSubtitle> for SubRipSubtitle

fn from(value: PlainSubtitle) -> Self

Converts to this type from the input type.

impl From<SsaSubtitle> for SubRipSubtitle

fn from(value: SsaSubtitle) -> Self

Converts to this type from the input type.

impl From<SubRipSubtitle> for AssSubtitle

fn from(value: SubRipSubtitle) -> Self

Converts to this type from the input type.

impl From<SubRipSubtitle> for SsaSubtitle

fn from(value: SubRipSubtitle) -> Self

Converts to this type from the input type.

impl From<SubRipSubtitle> for WebVttSubtitle

fn from(value: SubRipSubtitle) -> Self

Converts to this type from the input type.

impl From<TimedMicroDvdSubtitle> for SubRipSubtitle

fn from(value: TimedMicroDvdSubtitle) -> Self

Converts to this type from the input type.

impl From<TimedSubtitleFile> for SubRipSubtitle

fn from(value: TimedSubtitleFile) -> Self

Converts to this type from the input type.

impl From<WebVttSubtitle> for SubRipSubtitle

fn from(value: WebVttSubtitle) -> Self

Converts to this type from the input type.

impl FromStr for SubRipSubtitle

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Subtitle for SubRipSubtitle

type Event = SubRipEvent

Event type for the given subtitle format

fn from_path_with_encoding( path: impl AsRef<Path>, encoding: Option<&'static Encoding> ) -> Result<Self, Error>

Load subtitle format from path using the given encoding

fn events(&self) -> &[SubRipEvent]

Get list of events as a slice

fn events_mut(&mut self) -> &mut [SubRipEvent]

Get list of events as a mutable slice

fn from_path(path: impl AsRef<Path>) -> Result<Self, Error>

Load subtitle from given path. Automatically attempts to detect the encoding to use from the file contents.

fn event(&self, index: usize) -> Option<&Self::Event>

Try to get event at given index

fn event_mut(&mut self, index: usize) -> Option<&mut Self::Event>

Try to get mutable event at given index

fn export(&self, path: impl AsRef<Path>) -> Result<(), Error>

Write subtitles to file at the given path

impl TextSubtitle for SubRipSubtitle

fn strip_formatting(&mut self)

Remove all styling/formatting information from the text and subtitle metadata

impl TimedSubtitle for SubRipSubtitle

fn shift(&mut self, delta: TimeDelta)

where <Self as Subtitle>::Event: TimedEvent,

Shift all events in subtitle by given amount of time, in milliseconds.