Enum MarkdownStyle

#[non_exhaustive]
pub enum MarkdownStyle {
    Normal,
    RstCompat,
}

The type of markdown generated by Docs::to_markdown()

Note that this only controls markdown generated by this code. Existing markdown in the Rust documentation will not be sanitized in any way.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Normal

Regular markdown with no specific extensions, compatible with most common flavors

RstCompat

Markdown that can be losslessly converted to ReStructuredText

Trait Implementations

impl Clone for MarkdownStyle

fn clone(&self) -> MarkdownStyle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownStyle

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

Formats the value using the given formatter.

impl PartialEq for MarkdownStyle

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for MarkdownStyle

impl StructuralPartialEq for MarkdownStyle