Struct DocRef 

pub struct DocRef<'a, T> { /* private fields */ }

Implementations

impl<'a, T> DocRef<'a, T>

pub fn crate_docs(&self) -> &'a RustdocData

pub fn item(&self) -> &'a T

pub fn navigator(&self) -> &'a Navigator

pub fn set_name(&mut self, name: &'a str) -> &mut Self

pub fn with_name(self, name: &'a str) -> Self

impl<'a, T> DocRef<'a, T>

pub fn build_ref<U>(&self, inner: &'a U) -> DocRef<'a, U>

pub fn get_path(&self, id: Id) -> Option<DocRef<'a, Item>>

impl<'a> DocRef<'a, Item>

pub fn name(&self) -> Option<&'a str>

pub fn inner(&self) -> &'a ItemEnum

pub fn path(&self) -> Option<Path<'a>>

pub fn summary(&self) -> Option<&'a ItemSummary>

pub fn find_child(&self, child_name: &str) -> Option<DocRef<'a, Item>>

pub fn find_by_path<'b>( &self, iter: impl Iterator<Item = &'b String>, ) -> Option<DocRef<'a, Item>>

pub fn discriminated_path(&self) -> Option<String>

Returns the fully-qualified, kind-discriminated path for this item, suitable for round-tripping through Navigator::resolve_path.

For example, a Vec struct in std::vec returns "std::vec::struct@Vec", and the vec module itself returns "std::mod@vec". The crate name is included as the first segment; the discriminator (kind@) appears only on the final segment.

Uses crate_docs().name() (the Navigator’s canonical crate name) rather than ItemSummary::path[0] (which rustdoc normalizes to underscores) so that the generated path round-trips correctly through Navigator::resolve_path.

Returns None if the item has no ItemSummary entry in the crate’s paths map.

pub fn kind(&self) -> ItemKind

impl<'a, T> DocRef<'a, T>

pub fn get(&self, id: &Id) -> Option<DocRef<'a, Item>>

impl<'a> DocRef<'a, Use>

pub fn use_name(self) -> &'a str

impl<'a> DocRef<'a, ItemSummary>

pub fn external_crate(&self) -> Option<DocRef<'a, ExternalCrate>>

Get the external crate this item summary refers to, if any. Returns None if crate_id == 0 (same crate).

impl<'a> DocRef<'a, ExternalCrate>

pub fn crate_name(&self) -> &'a str

Get the canonical name of this external crate. Parses html_root_url if available, falls back to the name field.

pub fn load(&self) -> Option<&'a RustdocData>

Load the RustdocData for this external crate.

impl<'a> DocRef<'a, Item>

pub fn methods(&self) -> MethodIter<'a>

pub fn traits(&self) -> TraitIter<'a>

pub fn child_items(&self) -> ChildItems<'a>

impl<'a, T> DocRef<'a, T>

pub fn id_iter(&self, ids: &'a [Id]) -> IdIter<'a, T>

impl<'a> DocRef<'a, Item>

pub fn implementors(&self) -> ImplementorIter<'a>

Iterate impl blocks in this crate that implement this trait.

Trait Implementations

impl<'a, T> Clone for DocRef<'a, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for DocRef<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> Deref for DocRef<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T> From<&DocRef<'a, T>> for &'a RustdocData

fn from(value: &DocRef<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T> From<DocRef<'a, T>> for &'a RustdocData

fn from(value: DocRef<'a, T>) -> Self

Converts to this type from the input type.

impl Hash for DocRef<'_, Item>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T> PartialEq for DocRef<'a, T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T> Copy for DocRef<'a, T>

impl<'a, T> Eq for DocRef<'a, T>