Struct Vtt

pub struct Vtt<'a> {
    pub slugs: HashMap<&'a str, &'a str>,
    pub style: Option<&'a str>,
    pub cues: Vec<VttCue<'a>>,
}

(web)VTT — Web Video Text Tracks This struct represents a parsed VTT file. It contains a list of cues and optional metadata.

Fields

slugs: HashMap<&'a str, &'a str>

Top level key-value metadata pairs that might be populated at the very top of the subtitles file. For example:

WEBVTT
Kind: captions
Language: en

style: Option<&'a str>

Optional global css style can be populated at the very top of the file. If it is present it might be applied globally to all cues.

For example:

STYLE
::cue {
   background-image: linear-gradient(to bottom, dimgray, lightgray);
   color: papayawhip;
   font-size: 50px;
   text-align: center;
   font-family: monospace;
 }

cues: Vec<VttCue<'a>>

A list of cues that are present in the file. Each cue contains a start and end time, text and optional cue settings.

For example:

WEBVTT
00:00.000 --> 00:05.000
Hey subtitle one

Implementations

impl<'a> Vtt<'a>

pub fn parse(content: &'a str) -> Result<Self, VttError>

Parse webvtt subtitles from provided string. Make sure that it does not allocate any string data and only references parts of the original string.

Example

use webvtt_parser::{Vtt, VttCue, VttCueSettings, Align, Time};

let vtt = Vtt::parse("WEBVTT

00:00.000 --> 00:05.000
Hey subtitle one

00:05.000 --> 00:08.000 align:end
Hey subtitle two
").unwrap();

assert_eq!(vtt.cues.len(), 2);
assert_eq!(vtt.cues[0], VttCue { start: Time::from_milliseconds(0), end: Time::from_milliseconds(5000), text: "Hey subtitle one", name: None, note: None, cue_settings: None });
assert_eq!(vtt.cues[1].cue_settings, Some(VttCueSettings { align: Some(Align::End), position: None, vertical: None, size: None, line: None }));

pub fn to_owned(&self) -> OwnedVtt

Clones all the borrowes strings and returns the owned oversion of the vtt data.

Trait Implementations

impl<'a> Clone for Vtt<'a>

fn clone(&self) -> Vtt<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Vtt<'a>

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

Formats the value using the given formatter.

impl Display for Vtt<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a OwnedVtt> for Vtt<'a>

fn from(value: &'a OwnedVtt) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Vtt<'a>

fn eq(&self, other: &Vtt<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl ASubtitle for Vtt<'_>

impl<'a> Eq for Vtt<'a>

impl<'a> StructuralPartialEq for Vtt<'a>