Struct Document 

#[non_exhaustive]
pub struct Document {
    pub tt: TtElement,
    pub xml_declaration: Option<XmlDeclaration>,
}

A parsed TTML document.

This is the top-level type. Create one with Document::parse_str.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

tt: TtElement

The root <tt> element.

xml_declaration: Option<XmlDeclaration>

Any XML declaration attributes (version, encoding).

Implementations

impl Document

pub fn new() -> Self

Create a new empty document for from-scratch construction.

Use this to build TTML documents programmatically. Fields marked #[non_exhaustive] can be constructed using ..Default::default() where Default is implemented.

pub fn parse_str(xml: &str) -> Result<Self>

Parse a TTML document from an XML string.

pub fn to_xml(&self) -> String

Serialize this document to an XML string.

pub fn time_context(&self) -> TimeContext

Get the effective time context from the root <tt> element’s parameter attributes.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Document

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Document