Struct Docs 

pub struct Docs<'a> { /* private fields */ }

The rustdoc documents a resolution may walk: the package’s own, plus zero or more workspace-local crates its types can be defined in.

Auxiliary documents are consulted in the order given, and only after the TypeTable — an explicit mapping is the documented escape hatch for a type soothfast would otherwise get wrong, so it has to keep winning over anything derived.

Implementations

impl<'a> Docs<'a>

pub fn single(primary: &'a Value) -> Self

One document, the way single-crate resolution has always worked.

pub fn new(primary: &'a Value, aux: &'a [Value]) -> Self

A package’s document plus the workspace-local crates it reaches into.

pub fn primary(self) -> &'a Value

The package’s own rustdoc document.

pub fn aux(self) -> &'a [Value]

The auxiliary documents, in consultation order.

Trait Implementations

impl<'a> Clone for Docs<'a>

fn clone(&self) -> Docs<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Docs<'a>

impl<'a> From<&'a Value> for Docs<'a>

fn from(primary: &'a Value) -> Self

Converts to this type from the input type.