Config

Struct Config 

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

Configuration for Markdown pretty-printing output.

Implementations§

Source§

impl Config

Source

pub fn with_width(self, width: usize) -> Self

Render document with a given width in characters.

Source

pub fn with_spaces_before_list_item(self, spaces: usize) -> Self

Sets the number of spaces to insert before each list item when rendering the AST to Markdown.

The default is 1 space. According to the GitHub Flavored Markdown specification, between 0 and 3 spaces before a list marker are allowed: https://github.github.com/gfm/#lists

§Parameters
  • spaces: the number of spaces to insert before each list item (valid range: 0..=3).
§Returns

A new printer config instance with spaces_before_list_item set to the specified value.

Source

pub fn with_empty_line_before_list(self, tight: bool) -> Self

Sets whether to add an empty line before lists.

The default is true, which means that lists are preceded by an empty line.

Trait Implementations§

Source§

impl Default for Config

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnwindSafe for Config

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> 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, 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.