Skip to main content

PackagistRegistry

Struct PackagistRegistry 

Source
pub struct PackagistRegistry { /* private fields */ }
Expand description

Client for interacting with the Packagist registry.

Uses the Packagist v2 API for package metadata and search. All requests are cached via the provided HttpCache.

Implementations§

Source§

impl PackagistRegistry

Source

pub fn new(cache: Arc<HttpCache>) -> PackagistRegistry

Creates a new Packagist registry client with the given HTTP cache.

Source

pub async fn get_versions( &self, name: &str, ) -> Result<Vec<ComposerVersion>, DepsError>

Fetches all versions for a package from the Packagist v2 API.

Filters out dev versions (starting with dev- or ending with -dev). Returns versions in the order returned by the API (newest first).

§Errors

Returns an error if the HTTP request or JSON parsing fails.

Source

pub async fn get_latest_matching( &self, name: &str, req_str: &str, ) -> Result<Option<ComposerVersion>, DepsError>

Finds the latest non-abandoned version satisfying the given requirement.

Applies the same minimum-stability: stable default as Registry::select_latest_matching (#421): an alpha/beta/RC release is excluded unless req_str itself is prerelease-bearing. Under a wildcard/empty req_str (see deps_core::is_existence_wildcard_str) this is an existence check, not an upgrade recommendation, so it falls back to deps_core::select_latest_for_existence — matching deps-cargo/deps-pypi/deps-dart/deps-npm — rather than returning None for a package whose only releases so far are all prerelease.

Equivalent to get_latest_matching_for_manifest with no manifest minimum-stability (None) — use that method instead when the caller has a parsed composer.json available (#424).

§Errors

Returns an error if the HTTP request fails.

Source

pub async fn get_latest_matching_for_manifest( &self, name: &str, req_str: &str, minimum_stability: Option<&str>, ) -> Result<Option<ComposerVersion>, DepsError>

composer.json-aware counterpart of get_latest_matching: minimum_stability is the manifest’s own top-level minimum-stability field (ComposerParseResult::minimum_stability), used as the default stability floor whenever req_str carries neither an explicit per-dependency @stability flag nor a directly pinned prerelease version — both of which still take priority over the manifest default, exactly as they do for get_latest_matching (#424).

§Errors

Returns an error if the HTTP request fails.

Source

pub fn select_latest_matching_for_manifest( &self, versions: &[Box<dyn Version>], req: &VersionReq, minimum_stability: Option<&str>, ) -> Option<usize>

composer.json-aware counterpart of Registry::select_latest_matching: minimum_stability is the manifest’s own top-level minimum-stability field (ComposerParseResult::minimum_stability), used as the default stability floor whenever req carries neither an explicit per-dependency @stability flag nor a directly pinned prerelease version — both of which still take priority over the manifest default, exactly as they do for the plain trait method (#424).

Source

pub async fn search( &self, query: &str, limit: usize, ) -> Result<Vec<ComposerPackage>, DepsError>

Searches for packages by name/keywords.

Returns up to limit results sorted by relevance.

§Errors

Returns an error if the HTTP request or JSON parsing fails.

Trait Implementations§

Source§

impl Clone for PackagistRegistry

Source§

fn clone(&self) -> PackagistRegistry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Registry for PackagistRegistry

Source§

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>>

Routes to PackagistRegistry::get_latest_matching_for_manifest — see that method for the full priority order. This is the trait-level hook a generic LSP fetch loop downcasting Arc<dyn Registry> cannot bypass by calling get_latest_matching instead (#424 S1).

Source§

fn select_latest_matching( &self, versions: &[Box<dyn Version>], req: &VersionReq, ) -> Option<usize>

Picks the latest version satisfying req, applying Composer’s default minimum-stability: stable semantics (#421): an alpha/beta/RC release is excluded from “latest” unless req itself names an unstable version (e.g. an exact 2.0.0-beta1 pin or a lower bound like >=2.0.0-beta1) — mirroring deps-nuget’s prerelease-bearing-requirement exception (registry.rs’s pick_latest_matching). dev-*/*-dev branches never reach here at all: expand_minified_versions already filters them out of every Registry::get_versions result.

Under a wildcard/empty req (see deps_core::is_existence_wildcard) this is an existence check, not an upgrade recommendation, so it defers to select_latest_for_existence_composer instead — matching the shape of deps-cargo/deps-pypi/deps-dart/deps-npm (a package whose only releases so far are all prerelease still resolves to its newest one rather than None), while keeping Composer’s own #347 ranking rule that abandoned never demotes a version.

Does not read composer.json’s own minimum-stability field — this trait method has no manifest context to read it from. A caller with a parsed manifest available should use PackagistRegistry::select_latest_matching_for_manifest instead, which this method is equivalent to with no manifest minimum-stability (None) (#424).

Source§

fn select_latest_matching_with_context( &self, versions: &[Box<dyn Version>], req: &VersionReq, minimum_stability: Option<&str>, ) -> Option<usize>

Routes to PackagistRegistry::select_latest_matching_for_manifest — the trait-level hook a generic LSP fetch loop downcasting Arc<dyn Registry> cannot bypass by calling the plain select_latest_matching instead (#424 S1).

Source§

fn get_versions<'a>( &'a self, name: &'a PackageName, ) -> Pin<Box<dyn Future<Output = Result<Vec<Box<dyn Version>>, DepsError>> + Send + 'a>>

Fetches all available versions for a package. Read more
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>>

Finds the latest version matching a version requirement. Read more
Source§

fn search<'a>( &'a self, query: &'a str, limit: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<Box<dyn Metadata>>, DepsError>> + Send + 'a>>

Searches for packages by name or keywords. Read more
Source§

fn reports_yanked(&self) -> bool

Whether get_versions results carry meaningful per-version yank/deprecation data via Version::removal_status. Read more
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Downcast to concrete registry type for ecosystem-specific operations
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>>

Like 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 more
Source§

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>>

Like 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 more
Source§

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>>

Like 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 more

Auto Trait Implementations§

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> 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more