Struct Document 

pub struct Document {
    pub blocks: Vec<Block>,
}

A parsed document.

Fields

blocks: Vec<Block>

Implementations

impl Document

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

Parses source with tables, strikethrough, and task lists enabled.

Nothing else is enabled: footnotes, smart punctuation, and math would each change what a plain document means, and a reader who wrote three dots did not ask for an ellipsis.

pub fn lines(&self) -> usize

pub fn truncate(&self, max: usize) -> (Self, usize)

The first max lines, and how many lines were left behind.

The count is the point. A document cut to fit says how much was cut, so a reader knows there is more rather than having to notice a fade.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Document

Returns the “default value” for a type.

impl Eq for Document

impl PartialEq for Document

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Document