Function parse_str

pub fn parse_str(
    format: SubtitleFormat,
    content: &str,
    fps: f64,
) -> Result<SubtitleFile>

Parse text subtitles, invoking the right parser given by format.

Returns an Err(ErrorKind::TextFormatOnly) if attempted on a binary file format.

Mandatory format specific options

See parse_bytes.

Examples found in repository

examples/example1.rs (line 23)

fn main() {
    // your setup goes here
    let path = PathBuf::from("path/your_example_file.ssa");
    let file_content: String = read_file(&path); // your own load routine

    // parse the file
    let format = get_subtitle_format(path.extension(), file_content.as_bytes()).expect("unknown format");
    let mut subtitle_file = parse_str(format, &file_content, 25.0).expect("parser error");
    let mut subtitle_entries: Vec<SubtitleEntry> = subtitle_file.get_subtitle_entries().expect("unexpected error");

    // shift all subtitle entries by 1 minute and append "subparse" to each subtitle line
    for subtitle_entry in &mut subtitle_entries {
        subtitle_entry.timespan += TimeDelta::from_mins(1);

        // image based subtitles like .idx (VobSub) don't have text, so
        // a text is optional
        if let Some(ref mut line_ref) = subtitle_entry.line {
            line_ref.push_str("subparse");
        }
    }

    // update the entries in the subtitle file
    subtitle_file.update_subtitle_entries(&subtitle_entries).expect("unexpected error");

    // print the corrected file to stdout
    let data: Vec<u8> = subtitle_file.to_data().expect("unexpected errror");
    let data_string = String::from_utf8(data).expect("UTF-8 conversion error");
    println!("{}", data_string);
}