Struct Markstream 

pub struct Markstream { /* private fields */ }

One markstream container: Markdown, an optional stream URL and options.

use autumn_plugin_markstream::{Markstream, Mode};
use autumn_web::html;

let page = html! {
    (Markstream::new("# Hello\n\nSome *Markdown*."))
    (Markstream::stream("/chat/42/stream").mode(Mode::Chat))
};
assert!(page.into_string().contains("data-markstream-src"));

Implementations

impl Markstream

pub fn new(markdown: impl Into<String>) -> Self

Renders static Markdown.

pub fn stream(url: impl Into<String>) -> Self

Streams Markdown from the Server-Sent Events at url.

Make the events with crate::sse::markstream_sse.

pub fn stream_from(self, url: impl Into<String>) -> Self

Streams more Markdown from url after the current content.

The URL must have the same origin as the page. An empty URL means no stream.

pub const fn mode(self, mode: Mode) -> Self

Sets the render mode. Without this call, markstream uses its own default mode.

pub const fn html_policy(self, policy: HtmlPolicy) -> Self

Sets the HTML policy. The default is HtmlPolicy::Escape.

pub const fn theme(self, theme: Theme) -> Self

Sets the color theme. The default is Theme::Auto.

pub const fn typewriter(self, on: bool) -> Self

Animates new text when on is true.

pub const fn max_live_nodes(self, nodes: u32) -> Self

Sets the maximum number of live nodes. 0 keeps all nodes live.

pub fn id(self, id: impl Into<String>) -> Self

Sets the container id.

pub fn class(self, class: impl Into<String>) -> Self

Adds CSS classes to the container. It always has markstream.

Trait Implementations

impl Clone for Markstream

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Markstream

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

Formats the value using the given formatter.

impl Default for Markstream

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Markstream

impl PartialEq for Markstream

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

Equality operator ==.

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

Inequality operator !=.

impl Render for Markstream

fn render(&self) -> Markup

Renders self as a block of Markup.

fn render_to(&self, buffer: &mut String)

Appends a representation of self to the given buffer.

impl StructuralPartialEq for Markstream