Struct kas_core::text::format::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<Markdown, 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 copy 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<(), Error>

Formats the value using the given formatter. Read more

source

impl EditableText for Markdown

source

fn set_string(&mut self, string: String)

Set unformatted text Read more

source

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

Swap the contiguous unformatted text with another string Read more

source

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

Insert a char at the given position Read more

source

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

Replace text at range with replace_with Read more

source

impl FormattableText for Markdown

source

fn as_str(&self) -> &str

Access whole text as contiguous str

source

fn font_tokens(&self, dpem: f32) -> OwningVecIter<FontToken>ⓘNotable traits for OwningVecIter<T>`impl<T> Iterator for OwningVecIter<T>where T: Clone, type Item = T;`

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<Markdown> for Markdown

source

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

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

1.0.0 · source

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. Read more

source

impl StructuralPartialEq for Markdown

Auto Trait Implementations

impl RefUnwindSafe for Markdown

impl Send for Markdown

impl Sync for Markdown

impl Unpin for Markdown

impl UnwindSafe for Markdown

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<S, T> Cast<T> for Swhere
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 Swhere
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 Swhere
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<F> FormattableTextDyn for Fwhere
F: 'static + FormattableText + Clone,

source

fn clone_boxed(&self) -> Box<dyn FormattableTextDyn + 'static, Global>

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>ⓘNotable traits for OwningVecIter<T>`impl<T> Iterator for OwningVecIter<T>where T: Clone, type Item = T;`

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

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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 Twhere
T: Clone,

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 for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct kas_core::text::format::Markdown

Implementations

impl Markdown

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

Trait Implementations

impl Clone for Markdown

fn clone(&self) -> Markdown

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

impl Debug for Markdown

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

impl EditableText for Markdown

fn set_string(&mut self, string: String)

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

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

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

impl FormattableText for Markdown

fn as_str(&self) -> &str

fn font_tokens(&self, dpem: f32) -> OwningVecIter<FontToken>ⓘNotable traits for OwningVecIter<T>impl<T> Iterator for OwningVecIter<T>where T: Clone, type Item = T;

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

fn str_len(&self) -> usize

impl PartialEq<Markdown> for Markdown

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

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

impl StructuralPartialEq for Markdown

Auto Trait Implementations

impl RefUnwindSafe for Markdown

impl Send for Markdown

impl Sync for Markdown

impl Unpin for Markdown

impl UnwindSafe for Markdown

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<S, T> Cast<T> for Swhere T: Conv<S>,

fn cast(self) -> T

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

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

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

fn cast_approx(self) -> T

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

fn cast_trunc(self) -> T

fn cast_nearest(self) -> T

fn cast_floor(self) -> T

fn cast_ceil(self) -> T

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

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

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

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

impl<F> FormattableTextDyn for Fwhere F: 'static + FormattableText + Clone,

fn clone_boxed(&self) -> Box<dyn FormattableTextDyn + 'static, Global>

fn str_len(&self) -> usize

fn as_str(&self) -> &str

fn font_tokens(&self, dpem: f32) -> OwningVecIter<FontToken>ⓘNotable traits for OwningVecIter<T>impl<T> Iterator for OwningVecIter<T>where T: Clone, type Item = T;

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

fn font_tokens(&self, dpem: f32) -> OwningVecIter<FontToken>ⓘNotable traits for OwningVecIter<T>`impl<T> Iterator for OwningVecIter<T>where T: Clone, type Item = T;`

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

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

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

impl<S, T> Cast<T> for Swhere
T: Conv<S>,

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

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

impl<F> FormattableTextDyn for Fwhere
F: 'static + FormattableText + Clone,

fn font_tokens(&self, dpem: f32) -> OwningVecIter<FontToken>ⓘNotable traits for OwningVecIter<T>`impl<T> Iterator for OwningVecIter<T>where T: Clone, type Item = T;`

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

impl<T> ToOwned for Twhere
T: Clone,

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

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