Skip to main content

HomeData

Struct HomeData 

Source
pub struct HomeData<'a> {
    pub description: &'a str,
    pub pages: usize,
    pub links: usize,
    pub sections: &'a [HomeSection<'a>],
    pub recent: &'a [HomeRecent<'a>],
}
Expand description

The home dashboard payload. PageContext.home is Some only for the index doc; every other page passes None (and the template skips the dashboard).

Fields§

§description: &'a str

Hero subtitle (the index doc’s frontmatter description). "" → omitted.

§pages: usize

Total published doc count — the “pages” stat tile.

§links: usize

Total resolved wikilink count — the “links” stat tile.

§sections: &'a [HomeSection<'a>]

Section cards (top-level folders). Empty → the Sections column is omitted.

§recent: &'a [HomeRecent<'a>]

The most-recent docs (build order, home excluded), capped for the panel.

Trait Implementations§

Source§

impl<'a> Serialize for HomeData<'a>

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for HomeData<'a>

§

impl<'a> RefUnwindSafe for HomeData<'a>

§

impl<'a> Send for HomeData<'a>

§

impl<'a> Sync for HomeData<'a>

§

impl<'a> Unpin for HomeData<'a>

§

impl<'a> UnsafeUnpin for HomeData<'a>

§

impl<'a> UnwindSafe for HomeData<'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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.