Struct somedoc::write::html::HtmlWriter

pub struct HtmlWriter<'a, W: Write> { /* fields omitted */ }

Implementation of the HTML writer structure, usually this is accessed via the writer function, but may be used directly.

Example

use somedoc::write::html::HtmlWriter;
use somedoc::write::{write_document_to_string, Writer};
use somedoc::model::visitor::walk_document;

let doc = make_some_document();
let mut out = std::io::stdout();
let writer = HtmlWriter::new(&mut out);
assert!(writer.write_document(&doc).is_ok());

Trait Implementations

impl<'a, W: Write> BlockVisitor for HtmlWriter<'a, W>

fn start_block(&self) -> Result<()>

Called at the start of each BlockContent instance, before any value.

fn comment(&self, value: &str) -> Result<()>

Visit each BlockContent::Comment instance.

fn start_heading(
    &self,
    level: &HeadingLevel,
    label: &Option<Label>
) -> Result<()>

Called at the start of each BlockContent::Heading instance, before any inner content.

fn end_heading(
    &self,
    level: &HeadingLevel,
    _label: &Option<Label>
) -> Result<()>

Called at the end of each BlockContent::Heading instance, after any inner content.

fn image(
    &self,
    value: &Image,
    _caption: &Option<Caption>,
    label: &Option<Label>
) -> Result<()>

Visit each BlockContent::Image instance.

fn math(
    &self,
    value: &Math,
    _caption: &Option<Caption>,
    label: &Option<Label>
) -> Result<()>

Visit each BlockContent::MathBlock instance.

fn start_list(&self, kind: &ListKind, label: &Option<Label>) -> Result<()>

Called at the start of each BlockContent::List instance, before any inner content.

fn end_list(&self, kind: &ListKind, _label: &Option<Label>) -> Result<()>

Called at the start of each BlockContent::List instance, before any inner content.

fn start_list_item(&self, label: &Option<Label>) -> Result<()>

Called at the start of each Item instance, before any inner content.

fn end_list_item(&self, _label: &Option<Label>) -> Result<()>

Called at the end of each Item instance, after any inner content.

fn start_definition_list(&self, label: &Option<Label>) -> Result<()>

Called at the start of each BlockContent::DefinitionList instance, before any inner content.

fn end_definition_list(&self, _label: &Option<Label>) -> Result<()>

Called at the end of each BlockContent::DefinitionList instance, after any inner content.

fn start_definition(&self, term: &str, label: &Option<Label>) -> Result<()>

Called at the start of each Definition instance term, before any inner content.

fn start_definition_list_text(&self) -> Result<()>

Called at the start of each Definition instance text, before any inner content.

fn end_definition_list_text(&self) -> Result<()>

Called at the end of each Definition instance text, after any inner content.

fn formatted(&self, value: &str, label: &Option<Label>) -> Result<()>

Visit each BlockContent::Formatted instance.

fn code_block(
    &self,
    code: &str,
    language: &Option<String>,
    _caption: &Option<Caption>,
    label: &Option<Label>
) -> Result<()>

Visit each BlockContent::CodeBlock instance.

fn start_paragraph(
    &self,
    _alignment: &Alignment,
    label: &Option<Label>
) -> Result<()>

Called at the start of each BlockContent::Paragraph instance, before any inner content.

fn end_paragraph(
    &self,
    _alignment: &Alignment,
    _label: &Option<Label>
) -> Result<()>

Called at the end of each BlockContent::Paragraph instance, after any inner content.

fn start_quote(&self, label: &Option<Label>) -> Result<()>

Called at the start of each BlockContent::Quote instance, before any inner content.

fn end_quote(&self, _label: &Option<Label>) -> Result<()>

Called at the end of each BlockContent::Quote instance, after any inner content.

fn thematic_break(&self) -> Result<()>

Visit each BlockContent::ThematicBreak instance.

fn end_block(&self) -> Result<()>

Called at the end of each BlockContent instance, after any value.

fn table_visitor(&self) -> Option<&dyn TableVisitor>

Return an implementation of the TableVisitor trait, if one exists.

fn inline_visitor(&self) -> Option<&dyn InlineVisitor>

Return an implementation of the InlineVisitor trait, if one exists.

fn start_abstract(&self) -> Result<()>

Called at the start of the document's abstract.

fn end_abstract(&self) -> Result<()>

Called at the end of the document's abstract.

fn front_matter(&self, value: &FrontMatter) -> Result<()>

Visit each BlockContent::FrontMatter instance.

fn end_definition(&self, term: &str, label: &Option<Label>) -> Result<()>

Called at the end of each Definition instance term, after any inner content.

impl<'a, W: Debug + Write> Debug for HtmlWriter<'a, W>

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

Formats the value using the given formatter.

impl<'a, W: Write> DocumentVisitor for HtmlWriter<'a, W>

fn start_document(&self) -> Result<()>

Called at the start of each Document instance, before any inner content.

fn metadata(&self, metadatum: &Metadata) -> Result<()>

Visit each Metadata instance.

fn block_visitor(&self) -> Option<&dyn BlockVisitor>

Return an implementation of the BlockVisitor trait, if one exists.

fn end_document(&self) -> Result<()>

Called at the end of each Document instance, after any inner content.

fn start_metadata(&self) -> Result<()>

Called before any metadata items, and only if there are metadata items.

fn end_metadata(&self) -> Result<()>

Called after any metadata items, and only if there are metadata items.

impl<'a, W: Write> InlineVisitor for HtmlWriter<'a, W>

fn link(&self, value: &HyperLink) -> Result<()>

Visit each InlineContent::HyperLink instance.

fn image(&self, value: &Image) -> Result<()>

Visit each InlineContent::Image instance.

fn text(&self, value: &Text) -> Result<()>

Visit each InlineContent::Text instance.

fn math(&self, value: &Math) -> Result<()>

Visit each InlineContent::Math instance.

fn character(&self, value: &Character) -> Result<()>

Visit each InlineContent::Character instance.

fn line_break(&self) -> Result<()>

Visit each InlineContent::LineBreak instance.

fn start_span(&self, styles: &[SpanStyle]) -> Result<()>

Called at the start of each InlineContent::Span instance, before any inner content.

fn end_span(&self, styles: &[SpanStyle]) -> Result<()>

Called at the end of each InlineContent::Span instance, after any inner content.

impl<'a, W: Write> TableVisitor for HtmlWriter<'a, W>

fn start_table(
    &self,
    caption: &Option<Caption>,
    label: &Option<Label>
) -> Result<()>

Called at the start of each Table instance, before any values.

fn start_table_header_row(&self) -> Result<()>

Called at the start of each Table's header row, before any cells.

fn table_header_cell(&self, column_cell: &Column, _: usize) -> Result<()>

Visit each Column instance, with it's position.

fn end_table_header_row(&self) -> Result<()>

Called at the end of each Table's header row, after any cells.

fn start_table_row(&self, _: usize) -> Result<()>

Called at the start of each Table's body row, before any cells.

fn start_table_cell(&self, _: usize, label: &Option<Label>) -> Result<()>

Called at the start of each Cell instance, before any inner content.

fn end_table_cell(&self, _: usize, _label: &Option<Label>) -> Result<()>

Called at the end of each Cell instance, after any inner content.

fn end_table_row(&self, _: usize) -> Result<()>

Called at the end of each Table's body row, after any cells.

fn end_table(&self, _: &Option<Caption>, _label: &Option<Label>) -> Result<()>

Called at the end of each Table instance, after any values.

fn inline_visitor(&self) -> Option<&dyn InlineVisitor>

Return an implementation of the InlineVisitor trait, if one exists.

impl<'a, W: Write> Writer<'a, W> for HtmlWriter<'a, W>

fn new(w: &'a mut W) -> Self

Create a new writer using the write implementation provided.

fn write_document(&self, doc: &Document) -> Result<()>

Format and write the provided document using the Write instance given during construction.