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,
}
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 strlinks: &'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>.

Implementations

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

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

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
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