Trait Viewer 

pub trait Viewer<'a, Message, Theme = Theme, Renderer = Renderer<Renderer, Renderer>>: Sized + 'a
where
    Message: 'a,
    Theme: Catalog + 'a,
    Renderer: Renderer + 'a,
{
    // Required methods
    fn theme(&self) -> &Theme;
    fn highlighter(&self) -> &dyn Highlighter<Code, Theme>;
    fn on_link_click(url: String) -> Message;

    // Provided methods
    fn image(
        &self,
        settings: Settings,
        url: &'a String,
        title: &'a str,
        alt: &Text,
    ) -> Element<'a, Message, Theme, Renderer> { ... }
    fn heading(
        &self,
        settings: Settings,
        level: &'a HeadingLevel,
        text: &'a Text,
    ) -> Element<'a, Message, Theme, Renderer> { ... }
    fn paragraph(
        &self,
        settings: Settings,
        text: &Text,
    ) -> Element<'a, Message, Theme, Renderer> { ... }
    fn code_block(
        &self,
        settings: Settings,
        language: Option<&'a str>,
        code: &'a str,
        lines: &'a [Text],
    ) -> Element<'a, Message, Theme, Renderer> { ... }
    fn unordered_list(
        &self,
        settings: Settings,
        bullets: &'a [Bullet],
    ) -> Element<'a, Message, Theme, Renderer> { ... }
    fn ordered_list(
        &self,
        settings: Settings,
        start: u64,
        bullets: &'a [Bullet],
    ) -> Element<'a, Message, Theme, Renderer> { ... }
    fn quote(
        &self,
        settings: Settings,
        contents: &'a [Item],
    ) -> Element<'a, Message, Theme, Renderer> { ... }
    fn rule(&self) -> Element<'a, Message, Theme, Renderer> { ... }
    fn table(
        &self,
        settings: Settings,
        columns: &'a [Column],
        rows: &'a [Row],
    ) -> Element<'a, Message, Theme, Renderer> { ... }
}

Available on crate feature markdown only.

A view strategy to display a Markdown Item.

A Viewer is in charge of turning each Item into an [Element]. It also provides the Theme and text::Highlighter used for rendering.

Required Methods

fn theme(&self) -> &Theme

The Theme used for styling the Markdown elements.

fn highlighter(&self) -> &dyn Highlighter<Code, Theme>

The text::Highlighter used for highligthing Code regions.

fn on_link_click(url: String) -> Message

Produces a message when a link is clicked with the given Uri.

Provided Methods

fn image( &self, settings: Settings, url: &'a String, title: &'a str, alt: &Text, ) -> Element<'a, Message, Theme, Renderer>

Displays an image.

By default, it will show a container with the image title.

fn heading( &self, settings: Settings, level: &'a HeadingLevel, text: &'a Text, ) -> Element<'a, Message, Theme, Renderer>

Displays a heading.

By default, it calls heading.

fn paragraph( &self, settings: Settings, text: &Text, ) -> Element<'a, Message, Theme, Renderer>

Displays a paragraph.

By default, it calls paragraph.

fn code_block( &self, settings: Settings, language: Option<&'a str>, code: &'a str, lines: &'a [Text], ) -> Element<'a, Message, Theme, Renderer>

Displays a code block.

By default, it calls code_block.

fn unordered_list( &self, settings: Settings, bullets: &'a [Bullet], ) -> Element<'a, Message, Theme, Renderer>

Displays an unordered list.

By default, it calls unordered_list.

fn ordered_list( &self, settings: Settings, start: u64, bullets: &'a [Bullet], ) -> Element<'a, Message, Theme, Renderer>

Displays an ordered list.

By default, it calls ordered_list.

fn quote( &self, settings: Settings, contents: &'a [Item], ) -> Element<'a, Message, Theme, Renderer>

Displays a quote.

By default, it calls quote.

fn rule(&self) -> Element<'a, Message, Theme, Renderer>

Displays a rule.

By default, it calls rule.

fn table( &self, settings: Settings, columns: &'a [Column], rows: &'a [Row], ) -> Element<'a, Message, Theme, Renderer>

Displays a table.

By default, it calls table.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<'a, Theme, Renderer> Viewer<'a, String, Theme, Renderer> for DefaultViewer<'a, Theme>

where Theme: Catalog + 'a, Renderer: Renderer + 'a,