Struct kas_text::format::Markdown[−][src]

pub struct Markdown { /* fields omitted */ }

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), strikethrough

Not supported:

Block quotes
Footnotes
HTML
Horizontal rules
Images
Links
Tables
Task lists

Implementations

[src]

impl Markdown

[src]

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

Parse the input as Markdown

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

Trait Implementations

[src]

impl Clone for Markdown

[src]

fn clone(&self) -> Markdown

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl Debug for Markdown

[src]

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

Formats the value using the given formatter. Read more

[src]

impl EditableText for Markdown

[src]

fn set_string(&mut self, string: String)

Set unformatted text Read more

[src]

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

Swap the contiguous unformatted text with another string Read more

[src]

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

Insert a char at the given position Read more

[src]

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

Replace text at range with replace_with Read more

[src]

impl FormattableText for Markdown

[src]

fn as_str(&self) -> &str

Access whole text as contiguous str

[src]

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

Construct an iterator over formatting items Read more

[src]

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

Get the sequence of effect tokens Read more

[src]

fn str_len(&self) -> usize

Length of text Read more

[src]

impl PartialEq<Markdown> for Markdown

[src]

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

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

[src]

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

This method tests for !=.

[src]

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

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

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

[src]

pub fn cast(self) -> T

Cast from Self to T

[src]

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

Try converting from Self to T

[src]

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

[src]

pub fn cast_trunc(self) -> T

Cast to integer, truncating Read more

[src]

pub fn cast_nearest(self) -> T

Cast to the nearest integer Read more

[src]

pub fn cast_floor(self) -> T

Cast the floor to an integer Read more

[src]

pub fn cast_ceil(self) -> T

Cast the ceiling to an integer Read more

[src]

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

Try converting to integer with truncation Read more

[src]

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

Try converting to the nearest integer Read more

[src]

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

Try converting the floor to an integer Read more

[src]

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

Try convert the ceiling to an integer Read more

[src]

impl<T> Conv<T> for T

[src]

pub fn conv(v: T) -> T

Convert from T to Self

[src]

pub fn try_conv(v: T) -> Result<T, Error>

Try converting from T to Self

[src]

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

[src]

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

Produce a boxed clone of self

[src]

pub fn str_len(&Self) -> usize

Length of text

[src]

pub fn as_str(&Self) -> &str

Access whole text as contiguous str

[src]

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

Construct an iterator over formatting items Read more

[src]

pub fn effect_tokens(&Self) -> &[Effect<()>]

Get the sequence of effect tokens Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

[src]

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

Struct kas_text::format::Markdown[−][src]

Implementations

impl Markdown

pub fn new(input: &str) -> Result<Self, 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

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, dpp: f32, pt_size: f32) -> OwningVecIter<FontToken>ⓘNotable traits for OwningVecIter<T>impl<T: Clone> Iterator for OwningVecIter<T> 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: &Markdown) -> 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 T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

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

pub fn cast(self) -> T

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

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

pub fn cast_trunc(self) -> T

pub fn cast_nearest(self) -> T

pub fn cast_floor(self) -> T

pub fn cast_ceil(self) -> T

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

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

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

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

impl<T> Conv<T> for T

pub fn conv(v: T) -> T

pub fn try_conv(v: T) -> Result<T, Error>

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

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

pub fn str_len(&Self) -> usize

pub fn as_str(&Self) -> &str

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

pub fn effect_tokens(&Self) -> &[Effect<()>]

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

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