Struct HtmlDocument 

pub struct HtmlDocument { /* private fields */ }

An HTML document.

Unlike the PagedDocument, this does not implement Hash because the HTML introspector is neither hashable nor guaranteed to be 100% derived from the output (due to the presence of root_mut which is used for cross-linking).

Implementations

impl HtmlDocument

pub fn new(output: HtmlOutput, info: DocumentInfo) -> Self

Creates a new paged document from its parts.

Internally builds the introspector.

pub fn root(&self) -> &HtmlElement

The document’s root HTML element.

pub fn root_mut(&mut self) -> &mut HtmlElement

The document’s root HTML element, mutably.

Technically, mutating the root can mess up the introspector. This should be fixed at some point (https://github.com/typst/typst/issues/7951).

pub fn root_node(&self) -> &HtmlNode

The document’s root HTML element, in its containing node wrapper.

pub fn info_mut(&mut self) -> &mut DocumentInfo

Details about the document, mutably.

pub fn introspector(&self) -> &Arc<HtmlIntrospector>

Provides the ability to execute queries on the document.

pub fn introspector_mut(&mut self) -> &mut HtmlIntrospector

Provides the ability to execute queries on the document.

Trait Implementations

impl Clone for HtmlDocument

fn clone(&self) -> HtmlDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HtmlDocument

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

Formats the value using the given formatter.

impl Document for HtmlDocument

fn info(&self) -> &DocumentInfo

Get the document’s metadata.

impl Output for HtmlDocument

fn introspector(&self) -> &dyn Introspector

Get the output’s introspector.

fn target() -> Target

The target associated with the output.

fn create( engine: &mut Engine<'_>, content: &Content, styles: StyleChain<'_>, ) -> SourceResult<Self>

Creates the output.