Skip to main content

Markdown

Struct Markdown 

Source
pub struct Markdown {
    pub markup: String,
    pub code_theme: String,
    pub inline_code_lexer: Option<String>,
    pub inline_code_theme: Option<String>,
    pub hyperlinks: bool,
    pub justify: Option<JustifyMethod>,
}
Expand description

Renders Markdown-formatted text to styled terminal output.

Supports headings, paragraphs, lists, code blocks, emphasis, links, block quotes, horizontal rules, and tables.

Fields§

§markup: String

Raw markdown source text.

§code_theme: String

Theme for syntax-highlighted code blocks (reserved for future use).

§inline_code_lexer: Option<String>

Lexer for inline code (reserved for future use).

§inline_code_theme: Option<String>

Theme for inline code (reserved for future use).

§hyperlinks: bool

Whether to display hyperlink URLs after link text.

§justify: Option<JustifyMethod>

Text justification method.

Implementations§

Source§

impl Markdown

Source

pub fn new(markup: &str) -> Self

Create a new Markdown renderer from raw markdown text.

Source

pub fn with_code_theme(self, theme: &str) -> Self

Set the code theme (builder pattern).

Set whether hyperlink URLs are shown (builder pattern).

Source

pub fn with_justify(self, justify: JustifyMethod) -> Self

Set the text justification (builder pattern).

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

Source§

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

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

impl Renderable for Markdown

Source§

fn gilt_console( &self, console: &Console, options: &ConsoleOptions, ) -> Vec<Segment>

Produce segments for rendering on the given console with given options.

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<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<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> RenderableExt for T
where T: Renderable + 'static,

Source§

fn into_boxed_renderable(self) -> RenderableBox

Convert this renderable into a RenderableBox for type-erased storage. Read more
Source§

impl<T> ToCompactString for T
where T: Display,

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.