rustdoc::html::render::sidebar

Struct Sidebar

source
pub(super) struct Sidebar<'a> {
    pub(super) title_prefix: &'static str,
    pub(super) title: &'a str,
    pub(super) is_crate: bool,
    pub(super) parent_is_crate: bool,
    pub(super) is_mod: bool,
    pub(super) blocks: Vec<LinkBlock<'a>>,
    pub(super) path: String,
}

Fields§

§title_prefix: &'static str§title: &'a str§is_crate: bool§parent_is_crate: bool§is_mod: bool§blocks: Vec<LinkBlock<'a>>§path: String

Implementations§

source§

impl<'a> Sidebar<'a>

source

pub fn should_render_blocks(&self) -> bool

Only create a <section> if there are any blocks which should actually be rendered.

Trait Implementations§

source§

impl<'a> Display for Sidebar<'a>

Implement the format!() trait for Sidebar

Please be aware of the rendering performance notice in the [Template][::rinja::Template] trait.

source§

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

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

impl<'a> FastWritable for Sidebar<'a>

source§

fn write_into<RinjaW: Write + ?Sized>(&self, dest: &mut RinjaW) -> Result

Used internally by rinja to speed up writing some types.
source§

impl<'a> Template for Sidebar<'a>

source§

const EXTENSION: Option<&'static str> = _

The template’s extension, if provided
source§

const SIZE_HINT: usize = 273usize

Provides a rough estimate of the expanded length of the rendered template. Larger values result in higher memory usage but fewer reallocations. Smaller values result in the opposite. This value only affects render. It does not take effect when calling render_into, write_into, the fmt::Display implementation, or the blanket ToString::to_string implementation.
source§

const MIME_TYPE: &'static str = "text/html; charset=utf-8"

The MIME type (Content-Type) of the data that gets rendered by this Template
source§

fn render_into<RinjaW>(&self, writer: &mut RinjaW) -> Result<()>
where RinjaW: Write + ?Sized,

Renders the template to the given writer fmt buffer
§

fn render(&self) -> Result<String, Error>

Helper method which allocates a new String and renders into it
§

fn write_into<W>(&self, writer: &mut W) -> Result<(), Error>
where W: Write + ?Sized,

Renders the template to the given writer io buffer

Auto Trait Implementations§

§

impl<'a> Freeze for Sidebar<'a>

§

impl<'a> RefUnwindSafe for Sidebar<'a>

§

impl<'a> Send for Sidebar<'a>

§

impl<'a> Sync for Sidebar<'a>

§

impl<'a> Unpin for Sidebar<'a>

§

impl<'a> UnwindSafe for Sidebar<'a>

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
§

impl<T> DynTemplate for T
where T: Template,

§

fn dyn_render(&self) -> Result<String, Error>

Helper method which allocates a new String and renders into it
§

fn dyn_render_into(&self, writer: &mut dyn Write) -> Result<(), Error>

Renders the template to the given writer fmt buffer
§

fn dyn_write_into(&self, writer: &mut dyn Write) -> Result<(), Error>

Renders the template to the given writer io buffer
§

fn extension(&self) -> Option<&'static str>

Helper function to inspect the template’s extension
§

fn size_hint(&self) -> usize

Provides a conservative estimate of the expanded length of the rendered template
§

fn mime_type(&self) -> &'static str

The MIME type (Content-Type) of the data that gets rendered by this Template
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 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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default 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.
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: 88 bytes