Skip to main content

MarkdownDocument

Struct MarkdownDocument 

Source
pub struct MarkdownDocument { /* private fields */ }
Expand description

A Markdown document parsed into MarkdownBlocks, which re-parses only what an edit could have changed.

MarkdownDocument::update finds the first byte that differs from the source it holds, goes back to the last top-level block boundary before it, and parses from there. For text that grows at its end (a streamed reply) that is the block being written, whatever the length of the document above it.

The grammar: paragraphs, ATX headings (# to ######), bullet lists (-, *, +) and ordered lists (1., 1)) with nesting by indentation, block quotes (>), fenced code (three or more backticks or tildes, with an optional language), and thematic breaks. A fence left open runs to the end of the text, so code shows while it is still arriving. Tables, setext headings, indented code, HTML blocks and reference links are read as paragraph text.

Implementations§

Source§

impl MarkdownDocument

Source

pub fn new() -> Self

An empty document.

Source

pub fn parse(source: &str) -> Self

Parse source whole.

Source

pub fn blocks(&self) -> &[MarkdownBlock]

The blocks, in document order.

Source

pub fn source(&self) -> &str

The source the blocks were parsed from.

Source

pub fn update(&mut self, source: &str) -> usize

Replace the source and bring the blocks up to date, parsing only from the last top-level block boundary before the first changed byte.

Returns the index of the first block that differs from before the call: every block below it is untouched, and it equals the new block count when nothing changed.

Trait Implementations§

Source§

impl Clone for MarkdownDocument

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MarkdownDocument

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MarkdownDocument

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for MarkdownDocument

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MarkdownDocument

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.