Skip to main content

Markdown

Struct Markdown 

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

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§

Source§

impl Markdown

Source

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§

Source§

impl Clone for Markdown

Source§

fn clone(&self) -> Markdown

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Markdown

Source§

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

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

impl Default for Markdown

Source§

fn default() -> Markdown

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

impl FormattableText for Markdown

Source§

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

Source§

fn as_str(&self) -> &str

Access whole text as contiguous str
Source§

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

Construct an iterator over formatting items Read more
Source§

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

Get the sequence of effect tokens Read more
Source§

fn str_len(&self) -> usize

Length of text Read more
Source§

impl PartialEq for Markdown

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Markdown

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<S, T> Cast<T> for S
where T: Conv<S>,

Source§

fn cast(self) -> T

Cast from Self to T Read more
Source§

fn try_cast(self) -> Result<T, Error>

Try converting from Self to T Read more
Source§

impl<S, T> CastApprox<T> for S
where T: ConvApprox<S>,

Source§

fn try_cast_approx(self) -> Result<T, Error>

Try approximate conversion from Self to T Read more
Source§

fn cast_approx(self) -> T

Cast approximately from Self to T Read more
Source§

impl<S, T> CastFloat<T> for S
where T: ConvFloat<S>,

Source§

fn cast_trunc(self) -> T

Cast to integer, truncating Read more
Source§

fn cast_nearest(self) -> T

Cast to the nearest integer Read more
Source§

fn cast_floor(self) -> T

Cast the floor to an integer Read more
Source§

fn cast_ceil(self) -> T

Cast the ceiling to an integer Read more
Source§

fn try_cast_trunc(self) -> Result<T, Error>

Try converting to integer with truncation Read more
Source§

fn try_cast_nearest(self) -> Result<T, Error>

Try converting to the nearest integer Read more
Source§

fn try_cast_floor(self) -> Result<T, Error>

Try converting the floor to an integer Read more
Source§

fn try_cast_ceil(self) -> Result<T, Error>

Try convert the ceiling to an integer 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<F> FormattableTextDyn for F
where F: FormattableText + Clone + 'static,

Source§

fn clone_boxed(&self) -> Box<dyn FormattableTextDyn>

Produce a boxed clone of self
Source§

fn str_len(&self) -> usize

Length of text
Source§

fn as_str(&self) -> &str

Access whole text as contiguous str
Source§

fn font_tokens(&self, dpem: f32) -> OwningVecIter<FontToken>

Construct an iterator over formatting items Read more
Source§

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

Get the sequence of effect tokens 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.