Struct OwnedVtt

pub struct OwnedVtt {
    pub slugs: HashMap<String, String>,
    pub style: Option<String>,
    pub cues: Vec<OwnedVttCue>,
}

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

Make sure that this version is used when you need to own the data. If its possible please use the Vtt struct instead.

Fields

slugs: HashMap<String, String>

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<String>

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<OwnedVttCue>

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 OwnedVtt

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

Trait Implementations

impl Clone for OwnedVtt

fn clone(&self) -> OwnedVtt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedVtt

fn fmt(&self, f: &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 PartialEq for OwnedVtt

fn eq(&self, other: &OwnedVtt) -> 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 OwnedVtt

impl Eq for OwnedVtt

impl StructuralPartialEq for OwnedVtt