Struct minimad::Text

pub struct Text<'a> {
    pub lines: Vec<Line<'a>>,
}

a text, that is just a collection of lines

Fields

lines: Vec<Line<'a>>

Implementations

impl<'s> Text<'s>

pub fn from_md_lines<I>(md_lines: I) -> Self where
    I: Iterator<Item = &'s str>, 

parse a text from markdown lines.

The main reason to use this one is to use the clean::lines function which is useful with raw literals:

use minimad::{clean, Text};
let md = clean::lines(r#"
    * some bullet item
    some text
        some_code();
"#);
let text = Text::from_md_lines(md.into_iter());

Trait Implementations

impl<'a> Clone for Text<'a>

fn clone(&self) -> Text<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Text<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Text<'a>

fn default() -> Text<'a>

Returns the "default value" for a type.

impl<'a> Eq for Text<'a>

impl<'s> From<&'s str> for Text<'s>

fn from(md: &str) -> Text<'_>

build a text from a multi-line string interpreted as markdown

impl<'a> PartialEq<Text<'a>> for Text<'a>

fn eq(&self, other: &Text<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Text<'a>) -> bool

This method tests for !=.

impl<'a> StructuralEq for Text<'a>

impl<'a> StructuralPartialEq for Text<'a>