Struct rsubs_lib::vtt::VTTFile

pub struct VTTFile {
    pub styles: Vec<VTTStyle>,
    pub lines: Vec<VTTLine>,
}

Contains VTTStyles and VTTLines

Fields

styles: Vec<VTTStyle>

lines: Vec<VTTLine>

Implementations

impl VTTFile

pub fn to_file(self, path: &str) -> Result<()>

Takes the path of the file in the form of a String to be written to as input.

Examples found in repository

examples/simplest_usage.rs (line 15)

fn main() {
    let mut sub: VTTFile = Subtitle::from_str("tests/fixtures/test.srt")
        .unwrap()
        .into();
    for style in sub.styles.iter_mut() {
        style.color = rsubs_lib::util::color::ColorType::VTTColor0A(rsubs_lib::util::color::RED);
    }
    for line in sub.lines.iter_mut() {
        line.line_text = line.line_text.clone() + "!!!!!!";
    }
    sub.to_file("result.vtt").unwrap();
}

examples/convert_around.rs (line 10)

fn main() {
    vtt::VTTFile::from(srt::SRTFile::from_str("./tests/fixtures/test.srt").unwrap()) // Can read either a file or a string
        // converts file to WEBVTT
        .to_file("./tests/fixtures/ex_test_1.vtt") // Writes the converted subtitle to a file
        .unwrap();
    ssa::SSAFile::from(vtt::parse("./tests/fixtures/test.vtt".to_string()).unwrap()) // converts file to SSA/ASS
        .to_file("./tests/fixtures/ex_test_1.ass")
        .unwrap();
    srt::SRTFile::from(ssa::parse("./tests/fixtures/test.ass".to_string()).unwrap())
        // converts file to SRT
        .to_file("./tests/fixtures/ex_test_1.srt")
        .unwrap();
}

pub fn to_ass(self) -> SSAFile

When converting to SSAFile, information about the VTTStyles is maintained but not applied.

pub fn to_srt(self) -> SRTFile

SRT is basically a VTT without the styles

Trait Implementations

impl Clone for VTTFile

fn clone(&self) -> VTTFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VTTFile

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

Formats the value using the given formatter.

impl Default for VTTFile

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VTTFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VTTFile

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

Formats the value using the given formatter.

impl From<SRTFile> for VTTFile

fn from(a: SRTFile) -> Self

Converts to this type from the input type.

impl From<SSAFile> for VTTFile

fn from(a: SSAFile) -> Self

Converts to this type from the input type.

impl From<Subtitle> for VTTFile

fn from(value: Subtitle) -> Self

Converts to this type from the input type.

impl From<VTTFile> for SRTFile

fn from(a: VTTFile) -> Self

Converts to this type from the input type.

impl From<VTTFile> for SSAFile

fn from(a: VTTFile) -> Self

Converts to this type from the input type.

impl FromStr for VTTFile

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 PartialEq for VTTFile

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for VTTFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for VTTFile

impl StructuralEq for VTTFile

impl StructuralPartialEq for VTTFile