Enum subparse::SubtitleFile

pub enum SubtitleFile {
    SubRipFile(SrtFile),
    SubStationAlpha(SsaFile),
    VobSubIdxFile(IdxFile),
    VobSubSubFile(VobFile),
    MicroDVDFile(MdvdFile),
}

Unified wrapper around the all individual subtitle file types.

Variants

SubRipFile(SrtFile)

.srt file

SubStationAlpha(SsaFile)

.ssa/.ass file

VobSubIdxFile(IdxFile)

.idx file

VobSubSubFile(VobFile)

.sub file (VobSub/binary)

MicroDVDFile(MdvdFile)

.sub file (MicroDVD/text)

Methods

impl SubtitleFile

pub fn get_subtitle_entries(&self) -> Result<Vec<SubtitleEntry>>

The subtitle entries can be changed by calling update_subtitle_entries().

pub fn update_subtitle_entries(&mut self, i: &[SubtitleEntry]) -> Result<()>

Set the entries from the subtitle entries from the get_subtitle_entries().

The length of the given input slice should always match the length of the vector length from get_subtitle_entries(). This function can not delete/create new entries, but preserves everything else in the file (formatting, authors, ...).

If the input entry has entry.line == None, the line will not be overwritten.

Be aware that .idx files cannot save time_spans_ (a subtitle will be shown between two consecutive timepoints/there are no separate starts and ends) - so the timepoint will be set to the start of the corresponding input-timespan.

pub fn to_data(&self) -> Result<Vec<u8>>

Returns a byte-stream in the respective format (.ssa, .srt, etc.) with the (probably) altered information.

Trait Implementations

impl Clone for SubtitleFile

fn clone(&self) -> SubtitleFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<SrtFile> for SubtitleFile

fn from(f: SrtFile) -> SubtitleFile

Performs the conversion.

impl From<SsaFile> for SubtitleFile

fn from(f: SsaFile) -> SubtitleFile

Performs the conversion.

impl From<IdxFile> for SubtitleFile

fn from(f: IdxFile) -> SubtitleFile

Performs the conversion.

impl From<VobFile> for SubtitleFile

fn from(f: VobFile) -> SubtitleFile

Performs the conversion.

impl From<MdvdFile> for SubtitleFile

fn from(f: MdvdFile) -> SubtitleFile

Performs the conversion.

impl Debug for SubtitleFile

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

Formats the value using the given formatter.