pub struct CratesIoRegistry { /* private fields */ }Expand description
Client for interacting with crates.io registry.
Uses the sparse index protocol for fast version lookups (via SparseIndexClient) and
the REST API for package search. All requests are cached via the provided HttpCache.
Implementations§
Source§impl CratesIoRegistry
impl CratesIoRegistry
Sourcepub fn new(cache: Arc<HttpCache>) -> CratesIoRegistry
pub fn new(cache: Arc<HttpCache>) -> CratesIoRegistry
Creates a new registry client with the given HTTP cache.
Sourcepub async fn get_versions(
&self,
name: &str,
) -> Result<Vec<CargoVersion>, DepsError>
pub async fn get_versions( &self, name: &str, ) -> Result<Vec<CargoVersion>, DepsError>
Fetches all versions for a crate from the sparse index.
Returns versions sorted newest-first. Includes yanked versions.
§Errors
Returns an error if:
- HTTP request fails
- Response body is invalid UTF-8
- JSON parsing fails
§Examples
let cache = Arc::new(HttpCache::new());
let registry = CratesIoRegistry::new(cache);
let versions = registry.get_versions("serde").await.unwrap();
assert!(!versions.is_empty());Sourcepub async fn get_versions_with(
&self,
name: &str,
_freshness: FreshnessSettings,
) -> Result<Vec<CargoVersion>, DepsError>
pub async fn get_versions_with( &self, name: &str, _freshness: FreshnessSettings, ) -> Result<Vec<CargoVersion>, DepsError>
Like Self::get_versions, but threads freshness through so a caller routing via
CargoRegistry’s get_versions_for_source crates.io fallback arms cannot silently
drop it if crates.io ever gains its own publish-time enrichment (issue #588 critic
M10) — today this is a pure pass-through, identical to Self::get_versions, since
crates.io’s sparse index carries no such enrichment yet.
Sourcepub async fn get_latest_matching(
&self,
name: &str,
req_str: &str,
) -> Result<Option<CargoVersion>, DepsError>
pub async fn get_latest_matching( &self, name: &str, req_str: &str, ) -> Result<Option<CargoVersion>, DepsError>
Finds the latest version matching the given semver requirement.
Only returns non-yanked versions.
§Errors
Returns an error if:
- Version requirement string is invalid semver
- HTTP request fails
§Examples
let cache = Arc::new(HttpCache::new());
let registry = CratesIoRegistry::new(cache);
let latest = registry.get_latest_matching("serde", "^1.0").await.unwrap();
assert!(latest.is_some());Sourcepub async fn search(
&self,
query: &str,
limit: usize,
) -> Result<Vec<CrateInfo>, DepsError>
pub async fn search( &self, query: &str, limit: usize, ) -> Result<Vec<CrateInfo>, DepsError>
Searches for crates by name/keywords.
Returns up to limit results sorted by relevance.
§Errors
Returns an error if:
- HTTP request fails
- JSON parsing fails
§Examples
let cache = Arc::new(HttpCache::new());
let registry = CratesIoRegistry::new(cache);
let results = registry.search("serde", 10).await.unwrap();
assert!(!results.is_empty());Trait Implementations§
Source§impl Clone for CratesIoRegistry
impl Clone for CratesIoRegistry
Source§fn clone(&self) -> CratesIoRegistry
fn clone(&self) -> CratesIoRegistry
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Registry for CratesIoRegistry
impl Registry for CratesIoRegistry
Source§fn get_versions<'a>(
&'a self,
name: &'a PackageName,
) -> Pin<Box<dyn Future<Output = Result<Vec<Box<dyn Version>>, DepsError>> + Send + 'a>>
fn get_versions<'a>( &'a self, name: &'a PackageName, ) -> Pin<Box<dyn Future<Output = Result<Vec<Box<dyn Version>>, DepsError>> + Send + 'a>>
Source§fn get_latest_matching<'a>(
&'a self,
name: &'a PackageName,
req: &'a VersionReq,
) -> Pin<Box<dyn Future<Output = Result<Option<Box<dyn Version>>, DepsError>> + Send + 'a>>
fn get_latest_matching<'a>( &'a self, name: &'a PackageName, req: &'a VersionReq, ) -> Pin<Box<dyn Future<Output = Result<Option<Box<dyn Version>>, DepsError>> + Send + 'a>>
Source§fn select_latest_matching(
&self,
versions: &[Box<dyn Version>],
req: &VersionReq,
) -> Option<usize>
fn select_latest_matching( &self, versions: &[Box<dyn Version>], req: &VersionReq, ) -> Option<usize>
Source§fn search<'a>(
&'a self,
query: &'a str,
limit: usize,
) -> Pin<Box<dyn Future<Output = Result<Vec<Box<dyn Metadata>>, DepsError>> + Send + 'a>>
fn search<'a>( &'a self, query: &'a str, limit: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<Box<dyn Metadata>>, DepsError>> + Send + 'a>>
Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Source§fn get_versions_with<'a>(
&'a self,
name: &'a PackageName,
freshness: FreshnessSettings,
) -> Pin<Box<dyn Future<Output = Result<Vec<Box<dyn Version>>, DepsError>> + Send + 'a>>
fn get_versions_with<'a>( &'a self, name: &'a PackageName, freshness: FreshnessSettings, ) -> Pin<Box<dyn Future<Output = Result<Vec<Box<dyn Version>>, DepsError>> + Send + 'a>>
get_versions, but lets a registry that can obtain
Version::published_at only through an extra request gate that request behind
freshness.enabled instead of always paying for it. Read moreSource§fn get_versions_from<'a>(
&'a self,
name: &'a PackageName,
source: &'a DependencySource,
freshness: FreshnessSettings,
) -> Pin<Box<dyn Future<Output = Result<Vec<Box<dyn Version>>, DepsError>> + Send + 'a>>
fn get_versions_from<'a>( &'a self, name: &'a PackageName, source: &'a DependencySource, freshness: FreshnessSettings, ) -> Pin<Box<dyn Future<Output = Result<Vec<Box<dyn Version>>, DepsError>> + Send + 'a>>
get_versions_with, but additionally carries the
dependency’s resolved DependencySource, for a registry that routes a single
fetch across more than one underlying index (e.g. deps-cargo’s CargoRegistry,
which dispatches a DependencySource::AlternateRegistry to a private sparse index
instead of crates.io). Read moreSource§fn get_latest_matching_with_context<'a>(
&'a self,
name: &'a PackageName,
req: &'a VersionReq,
minimum_stability: Option<&'a str>,
) -> Pin<Box<dyn Future<Output = Result<Option<Box<dyn Version>>, DepsError>> + Send + 'a>>
fn get_latest_matching_with_context<'a>( &'a self, name: &'a PackageName, req: &'a VersionReq, minimum_stability: Option<&'a str>, ) -> Pin<Box<dyn Future<Output = Result<Option<Box<dyn Version>>, DepsError>> + Send + 'a>>
get_latest_matching, but lets a registry whose
“latest matching” selection can be refined by ecosystem-specific manifest state (e.g.
Composer’s minimum-stability field, #424) read it, alongside req. Read moreSource§fn get_latest_matching_from<'a>(
&'a self,
name: &'a PackageName,
source: &'a DependencySource,
req: &'a VersionReq,
minimum_stability: Option<&'a str>,
) -> Pin<Box<dyn Future<Output = Result<Option<Box<dyn Version>>, DepsError>> + Send + 'a>>
fn get_latest_matching_from<'a>( &'a self, name: &'a PackageName, source: &'a DependencySource, req: &'a VersionReq, minimum_stability: Option<&'a str>, ) -> Pin<Box<dyn Future<Output = Result<Option<Box<dyn Version>>, DepsError>> + Send + 'a>>
get_latest_matching_with_context,
but additionally carries the dependency’s resolved DependencySource — the
get_latest_matching-shaped counterpart to
get_versions_from, covering the fallback path a caller
takes when the list-based pick fails on a non-empty get_versions_from
result (see deps_core::lsp_helpers::hover’s list_fallback_latest and
deps-lsp’s background-fetch fallback for the two call sites this exists for). Read moreSource§fn select_latest_matching_with_context(
&self,
versions: &[Box<dyn Version>],
req: &VersionReq,
minimum_stability: Option<&str>,
) -> Option<usize>
fn select_latest_matching_with_context( &self, versions: &[Box<dyn Version>], req: &VersionReq, minimum_stability: Option<&str>, ) -> Option<usize>
select_latest_matching, but lets a registry
whose selection can be refined by ecosystem-specific manifest state (e.g. Composer’s
minimum-stability field, #424) read it, alongside versions and req. See
get_latest_matching_with_context for why
minimum_stability is an opaque per-ecosystem string rather than a shared type. Read moreSource§fn reports_yanked(&self) -> bool
fn reports_yanked(&self) -> bool
get_versions results carry meaningful
per-version yank/deprecation data via Version::removal_status. Read moreAuto Trait Implementations§
impl !RefUnwindSafe for CratesIoRegistry
impl !UnwindSafe for CratesIoRegistry
impl Freeze for CratesIoRegistry
impl Send for CratesIoRegistry
impl Sync for CratesIoRegistry
impl Unpin for CratesIoRegistry
impl UnsafeUnpin for CratesIoRegistry
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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