Skip to main content

DocSite

Struct DocSite

pub struct DocSite {
    pub files: Vec<DocFile>,
}

Expand description

A renderable site composed of one entry per source file.

Fields§

§files: Vec<DocFile>

Implementations§

impl DocSite

pub fn from_ast( stem: impl Into<String>, ast: &Ast, interner: &ThreadedRodeo, ) -> DocFile

Build a DocSite from a single Ast + interner pair.

stem is the file’s display name (typically the source path’s stem). Anonymous types and items lacking docs still appear in the output — the renderer just shows their header.

pub fn push(&mut self, file: DocFile)

Add a DocFile produced by from_ast to this site.

pub fn link_table(&self) -> LinkTable

ADR-0089 Phase 5: build a LinkTable covering every top-level item in the site, with each slug prefixed by the containing file’s stem. Right for the site-level index page where every link is one directory away.

Trait Implementations§

impl Clone for DocSite

fn clone(&self) -> DocSite

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for DocSite

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

Formats the value using the given formatter. Read more

impl Default for DocSite

fn default() -> DocSite

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl Freeze for DocSite

impl RefUnwindSafe for DocSite

impl Send for DocSite

impl Sync for DocSite

impl Unpin for DocSite

impl UnsafeUnpin for DocSite

impl UnwindSafe for DocSite

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<'src, T> IntoMaybe<'src, T> for T
where T: 'src,

type Proj<U: 'src> = U

fn map_maybe<R>( self, _f: impl FnOnce(&'src T) -> &'src R, g: impl FnOnce(T) -> R, ) -> <T as IntoMaybe<'src, T>>::Proj<R>
where R: 'src,

impl<'p, T> Seq<'p, T> for T
where T: Clone,

type Item<'a> = &'a T where T: 'a

The item yielded by the iterator.

type Iter<'a> = Once<&'a T> where T: 'a

An iterator over the items within this container, by reference.

fn seq_iter(&self) -> <T as Seq<'p, T>>::Iter<'_>

Iterate over the elements of the container.

fn contains(&self, val: &T) -> bool
where T: PartialEq,

Check whether an item is contained within this sequence.

fn to_maybe_ref<'b>(item: <T as Seq<'p, T>>::Item<'b>) -> Maybe<T, &'p T>
where 'p: 'b,

Convert an item of the sequence into a [MaybeRef].

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> OrderedSeq<'_, T> for T
where T: Clone,