Struct rustdoc::html::layout::PageLayout

source · [−]

struct PageLayout<'a> {
    static_root_path: &'a str,
    page: &'a Page<'a>,
    layout: &'a Layout,
    themes: Vec<String>,
    sidebar: String,
    content: String,
    krate_with_trailing_slash: String,
    pub(crate) rustdoc_version: &'a str,
}

Fields

static_root_path: &'a strpage: &'a Page<'a>layout: &'a Layoutthemes: Vec<String>sidebar: Stringcontent: Stringkrate_with_trailing_slash: Stringrustdoc_version: &'a str

Trait Implementations

source

impl<'a> Display for PageLayout<'a>

source

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

Formats the value using the given formatter. Read more

source

impl<'a> Template for PageLayout<'a>

source

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

Renders the template to the given writer buffer

source

const EXTENSION: Option<&'static str>

The template’s extension, if provided

source

const SIZE_HINT: usize

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

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

Helper method which allocates a new String and renders into it

Auto Trait Implementations

impl<'a> RefUnwindSafe for PageLayout<'a>

impl<'a> Send for PageLayout<'a>

impl<'a> Sync for PageLayout<'a>

impl<'a> Unpin for PageLayout<'a>

impl<'a> UnwindSafe for PageLayout<'a>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

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

Helper method which allocates a new String and renders into it

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

Renders the template to the given writer buffer

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

Helper function to inspect the template’s extension

pub fn size_hint(&self) -> usize

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

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

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 for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

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

source

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

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

source

impl<'a, T> Captures<'a> for T where
T: ?Sized,

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: 144 bytes

Struct rustdoc::html::layout::PageLayout

Fields

Trait Implementations

impl<'a> Display for PageLayout<'a>

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

impl<'a> Template for PageLayout<'a>

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

const EXTENSION: Option<&'static str>

const SIZE_HINT: usize

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

Auto Trait Implementations

impl<'a> RefUnwindSafe for PageLayout<'a>

impl<'a> Send for PageLayout<'a>

impl<'a> Sync for PageLayout<'a>

impl<'a> Unpin for PageLayout<'a>

impl<'a> UnwindSafe for PageLayout<'a>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

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

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

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

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

pub fn size_hint(&self) -> usize

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

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

pub default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<'a, T> Captures<'a> for T where T: ?Sized,

Layout

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

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

impl<T, U> Into<U> for T where
U: From<T>,

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

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

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

impl<'a, T> Captures<'a> for T where
T: ?Sized,