Struct cargo::sources::registry::RegistrySource

pub struct RegistrySource<'cfg> { /* private fields */ }

A “source” for a local (see local::LocalRegistry) or remote (see remote::RemoteRegistry) registry.

This contains common functionality that is shared between the two registry kinds, with the registry-specific logic implemented as part of the RegistryData trait referenced via the ops field.

Implementations

impl<'cfg> RegistrySource<'cfg>

pub fn remote(
    source_id: SourceId,
    yanked_whitelist: &HashSet<PackageId>,
    config: &'cfg Config
) -> RegistrySource<'cfg>

pub fn local(
    source_id: SourceId,
    path: &Path,
    yanked_whitelist: &HashSet<PackageId>,
    config: &'cfg Config
) -> RegistrySource<'cfg>

pub fn config(&mut self) -> CargoResult<Option<RegistryConfig>>

Decode the configuration stored within the registry.

This requires that the index has been at least checked out.

Trait Implementations

impl<'cfg> Source for RegistrySource<'cfg>

fn query(
    &mut self,
    dep: &Dependency,
    f: &mut dyn FnMut(Summary)
) -> CargoResult<()>

Attempts to find the packages that match a dependency request.

fn fuzzy_query(
    &mut self,
    dep: &Dependency,
    f: &mut dyn FnMut(Summary)
) -> CargoResult<()>

Attempts to find the packages that are close to a dependency request. Each source gets to define what close means for it. Path/Git sources may return all dependencies that are at that URI, whereas an Index source may return dependencies that have the same canonicalization.

fn supports_checksums(&self) -> bool

Returns whether or not this source will return summaries with checksums listed.

fn requires_precise(&self) -> bool

Returns whether or not this source will return summaries with the precise field in the source id listed.

fn source_id(&self) -> SourceId

Returns the SourceId corresponding to this source.

fn update(&mut self) -> CargoResult<()>

Performs any network operations required to get the entire list of all names, versions and dependencies of packages managed by the Source.

fn download(&mut self, package: PackageId) -> CargoResult<MaybePackage>

Fetches the full package for each name and version specified.

fn finish_download(
    &mut self,
    package: PackageId,
    data: Vec<u8>
) -> CargoResult<Package>

fn fingerprint(&self, pkg: &Package) -> CargoResult<String>

Generates a unique string which represents the fingerprint of the current state of the source.

fn describe(&self) -> String

Describes this source in a human readable fashion, used for display in resolver error messages currently.

fn add_to_yanked_whitelist(&mut self, pkgs: &[PackageId])

Add a number of crates that should be whitelisted for showing up during queries, even if they are yanked. Currently only applies to registry sources.

fn is_yanked(&mut self, pkg: PackageId) -> CargoResult<bool>

Query if a package is yanked. Only registry sources can mark packages as yanked. This ignores the yanked whitelist.

fn replaced_source_id(&self) -> SourceId

Returns the replaced SourceId corresponding to this source.

fn query_vec(&mut self, dep: &Dependency) -> CargoResult<Vec<Summary>>

fn download_now(
    self: Box<Self>,
    package: PackageId,
    config: &Config
) -> CargoResult<Package> where
    Self: Sized, 

fn verify(&self, _pkg: PackageId) -> CargoResult<()>

If this source supports it, verifies the source of the package specified.

fn is_replaced(&self) -> bool

Returns whether a source is being replaced by another here.