Skip to main content

Resolver

Struct Resolver 

Source
pub struct Resolver<'a> { /* private fields */ }
Expand description

A navigation engine over a Navigator.

Construct one per query (e.g. one per top-level command in a Request). The frame stack drains to empty between top-level methods, so a single Resolver is reusable across many lookups in the same operation.

Methods that walk through items take &mut self because resolution mutates the frame stack. Returned DocRefs borrow from the underlying Navigator, so they outlive the Resolver.

Implementations§

Source§

impl<'a> Resolver<'a>

Source

pub fn new(navigator: &'a Navigator) -> Self

Source

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

Source

pub fn current_path(&self) -> impl Iterator<Item = &str> + '_

Segments traversed in the current resolution chain. Empty between top-level calls.

Source§

impl<'a> Resolver<'a>

Source

pub fn resolve_path( &mut self, path: &str, suggestions: &mut Vec<Suggestion<'a>>, ) -> Option<DocRef<'a, Item>>

Resolve a path like "std::vec::Vec" or "tokio@1::runtime::Runtime".

Primary string entrypoint for any user-supplied crate or item path.

Source§

impl<'a> Resolver<'a>

Source

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

Find a child of parent named target. Used for single-segment lookups (e.g. walking item_summary.path to wire up “Defined at” links).

Source

pub fn find_by_path<'s>( &mut self, parent: DocRef<'a, Item>, segments: impl IntoIterator<Item = &'s str>, ) -> Option<DocRef<'a, Item>>

Walk a sequence of name segments from parent.

Source§

impl<'a> Resolver<'a>

Source

pub fn follow_use( &mut self, use_item: DocRef<'a, Use>, parent_module: DocRef<'a, Item>, ) -> Option<DocRef<'a, Item>>

Resolve a Use to its target item. Tries use_item.id first (cheap local lookup, can’t cycle); on miss, falls back to resolving the source path string against the parent module’s path.

parent_module is the module containing the Use, used to resolve self::/super:: prefixes in the source string.

Source

pub fn resolve_lazy_child( &mut self, child: LazyChild<'a>, ) -> Option<DocRef<'a, Item>>

Resolve a LazyChild to a concrete item. For non-glob Uses, the imported name is preserved on the returned DocRef.

Source§

impl<'a> Resolver<'a>

Source

pub fn children(&mut self, item: DocRef<'a, Item>) -> Vec<DocRef<'a, Item>>

Children of item with Uses resolved and globs expanded. Equivalent to the old item.child_items().

Source

pub fn children_including_uses( &mut self, item: DocRef<'a, Item>, ) -> Vec<DocRef<'a, Item>>

Children of item, but yield Use items themselves rather than their targets. Used by the search indexer to record use statements.

Source

pub fn ids( &mut self, parent: DocRef<'a, Item>, ids: &'a [Id], ) -> Vec<DocRef<'a, Item>>

Resolve a slice of Ids in parent, expanding Use items. Replaces the old id_iter.

Source

pub fn ids_including_uses( &mut self, parent: DocRef<'a, Item>, ids: &'a [Id], ) -> Vec<DocRef<'a, Item>>

Like Self::ids but yields Use items themselves instead of their targets.

Source§

impl<'a> Resolver<'a>

Source

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

Resolve an Id from origin’s crate to a DocRef. The id is looked up in origin’s rustdoc paths map; for external-crate ids this crosses the crate boundary, loading the target crate if needed and walking its public path.

Source

pub fn get_item_from_id_path( &mut self, crate_name: &str, ids: &[u32], ) -> Option<(DocRef<'a, Item>, Vec<&'a str>)>

Get an item from a sequence of Ids starting at the named crate’s root. Returns the resolved item plus the path of segment names.

Auto Trait Implementations§

§

impl<'a> Freeze for Resolver<'a>

§

impl<'a> !RefUnwindSafe for Resolver<'a>

§

impl<'a> Send for Resolver<'a>

§

impl<'a> Sync for Resolver<'a>

§

impl<'a> Unpin for Resolver<'a>

§

impl<'a> UnsafeUnpin for Resolver<'a>

§

impl<'a> !UnwindSafe for Resolver<'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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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.