Struct rustdoc::html::markdown::Markdown

source ·
pub struct Markdown<'a> {
    pub content: &'a str,
    pub links: &'a [RenderedLink],
    pub ids: &'a mut IdMap,
    pub error_codes: ErrorCodes,
    pub edition: Edition,
    pub playground: &'a Option<Playground>,
    pub heading_offset: HeadingOffset,
    pub custom_code_classes_in_docs: bool,
}
Expand description

When to_string is called, this struct will emit the HTML corresponding to the rendered version of the contained markdown string.

Fields§

§content: &'a str§links: &'a [RenderedLink]

A list of link replacements.

§ids: &'a mut IdMap

The current list of used header IDs.

§error_codes: ErrorCodes

Whether to allow the use of explicit error codes in doctest lang strings.

§edition: Edition

Default edition to use when parsing doctests (to add a fn main).

§playground: &'a Option<Playground>§heading_offset: HeadingOffset

Offset at which we render headings. E.g. if heading_offset: HeadingOffset::H2, then # something renders an <h2>.

§custom_code_classes_in_docs: bool

true if the custom_code_classes_in_docs feature is enabled.

Implementations§

source§

impl Markdown<'_>

source

pub fn into_string(self) -> String

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for Markdown<'a>

§

impl<'a> Send for Markdown<'a>

§

impl<'a> Sync for Markdown<'a>

§

impl<'a> Unpin for Markdown<'a>

§

impl<'a> !UnwindSafe for Markdown<'a>

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

§

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

§

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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 56 bytes