Struct Navigator 

pub struct Navigator { /* private fields */ }

Navigator orchestrates documentation lookup across multiple sources

Sources are checked in this order:

1. std (if crate name matches RUST_CRATES)
2. local (if LocalSource is present and has the crate)
3. docs.rs (if DocsRsSource is present)

Implementations

impl Navigator

pub fn std_source(&self) -> Option<&StdSource>

pub fn with_std_source(self, std_source: Option<StdSource>) -> Self

pub fn docsrs_source(&self) -> Option<&DocsRsSource>

pub fn with_docsrs_source(self, docsrs_source: Option<DocsRsSource>) -> Self

pub fn local_source(&self) -> Option<&LocalSource>

pub fn with_local_source(self, local_source: Option<LocalSource>) -> Self

impl Navigator

pub fn list_available_crates(&self) -> impl Iterator<Item = &CrateInfo>

List all available crate names from all sources Returns crate names from std library and local workspace/dependencies

pub fn lookup_crate<'a>( &'a self, name: &str, version: &VersionReq, ) -> Option<Cow<'a, CrateInfo>>

Look up a crate by name, returning canonical name and metadata Tries sources in priority order: std, local, docs.rs

pub fn project_root(&self) -> Option<&Path>

Get the project root path if a local context exists

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

Resolve a path like “std::vec::Vec” or “tokio::runtime::Runtime” or (custom format for this crate) “tokio@1::runtime::Runtime” or “serde@1.0.228::de”

This is the primary string entrypoint for any user-generated crate or type specification

pub fn canonicalize(&self, name: &str) -> CrateName<'static>

pub fn load_crate( &self, name: &str, version_req: &VersionReq, ) -> Option<&RustdocData>

Load a crate by name and optional version

If version is None:

• First checks external crate names from loaded crates
• For local context crates: use the locked version from Cargo.lock
• For arbitrary crates: use “latest”

Returns None if the crate cannot be found in any source

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

Get item from ID path

impl Navigator

pub fn search<'nav, 'query>( &'nav self, query: &'query str, crate_names: &'query [&'query str], ) -> Result<Vec<ScoredResult<'query>>, Vec<Suggestion<'nav>>>

Search across multiple crates with BM25 scoring

Returns results sorted by score (descending). Empty crate list returns empty results. Empty query triggers index loading but returns no matches (useful for prewarming).

Returns Err with suggestions if no crates could be loaded/indexed.

Trait Implementations

impl Debug for Navigator

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

Formats the value using the given formatter.

impl Default for Navigator

fn default() -> Navigator

Returns the “default value” for a type.