Skip to main content

SiteBuild

docgen_core::pipeline

Struct SiteBuild 

Source 
pub struct SiteBuild {
    pub docs: Vec<Doc>,
    pub graph: LinkGraph,
    pub search: Vec<SearchEntry>,
    pub any_mermaid: bool,
    pub any_components: bool,
}
Expand description

The fully assembled site after pass 2.

Fields§

§docs: Vec<Doc>§graph: LinkGraph§search: Vec<SearchEntry>§any_mermaid: bool

True if any doc contains a mermaid diagram. Lets the build subcommand flip EmitOptions.include_mermaid once for the whole site.

§any_components: bool

True if any doc used ≥1 custom component (gates the components asset slice).

Implementations§

Source§

impl SiteBuild

Source

pub fn graph_data(&self, params: LayoutParams) -> GraphData

Build the deterministic GraphData for the /graph/ page from this site’s docs (node order = doc order) and its already-built LinkGraph. Never recomputes links.

Auto Trait Implementations§

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.