Struct kas_text::format::Markdown

pub struct Markdown { /* private fields */ }

Basic Markdown formatter

Currently this misses several important Markdown features, but may still prove a convenient way of constructing formatted texts.

Supported:

• Text paragraphs
• Code (embedded and blocks); caveat: extra line after code blocks
• Explicit line breaks
• Headings
• Lists (numerated and bulleted); caveat: indentation after first line
• Bold, italic (emphasis), strike-through

Not supported:

• Block quotes
• Footnotes
• HTML
• Horizontal rules
• Images
• Links
• Tables
• Task lists

Implementations

impl Markdown

pub fn new(input: &str) -> Result<Self, Error>

Parse the input as Markdown

Parsing happens immediately. Fonts must be initialized before calling this method.

Trait Implementations

impl Clone for Markdown

fn clone(&self) -> Markdown

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Markdown

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

Formats the value using the given formatter.

impl EditableText for Markdown

fn set_string(&mut self, string: String)

Set unformatted text

fn swap_string(&mut self, string: &mut String)

Swap the contiguous unformatted text with another string

fn insert_char(&mut self, index: usize, c: char)

Insert a char at the given position

fn replace_range(&mut self, range: Range<usize>, replace_with: &str)

Replace text at range with replace_with

impl FormattableText for Markdown

type FontTokenIter<'a> = FontTokenIter<'a>

fn as_str(&self) -> &str

Access whole text as contiguous str

fn font_tokens<'a>(&'a self, dpem: f32) -> Self::FontTokenIter<'a>

Construct an iterator over formatting items

fn effect_tokens(&self) -> &[Effect<()>]

Get the sequence of effect tokens

fn str_len(&self) -> usize

Length of text

impl PartialEq<Markdown> for Markdown

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Markdown