pub struct RegistrySource<'cfg> {
    source_id: SourceId,
    src_path: Filesystem,
    config: &'cfg Config,
    ops: Box<dyn RegistryData + 'cfg>,
    index: RegistryIndex<'cfg>,
    yanked_whitelist: HashSet<PackageId>,
}
Expand description

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.

Fields§

§source_id: SourceId§src_path: Filesystem

The path where crate files are extracted ($CARGO_HOME/registry/src/$REG-HASH).

§config: &'cfg Config

Local reference to Config for convenience.

§ops: Box<dyn RegistryData + 'cfg>

Abstraction for interfacing to the different registry kinds.

§index: RegistryIndex<'cfg>

Interface for managing the on-disk index.

§yanked_whitelist: HashSet<PackageId>

A set of packages that should be allowed to be used, even if they are yanked.

This is populated from the entries in Cargo.lock to ensure that cargo update -p somepkg won’t unlock yanked entries in Cargo.lock. Otherwise, the resolver would think that those entries no longer exist, and it would trigger updates to unrelated packages.

Implementations§

source§

impl<'cfg> RegistrySource<'cfg>

source

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

source

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

source

fn new( source_id: SourceId, config: &'cfg Config, name: &str, ops: Box<dyn RegistryData + 'cfg>, yanked_whitelist: &HashSet<PackageId> ) -> RegistrySource<'cfg>

source

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

Decode the configuration stored within the registry.

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

source

fn unpack_package(&self, pkg: PackageId, tarball: &File) -> CargoResult<PathBuf>

Unpacks a downloaded package into a location where it’s ready to be compiled.

No action is taken if the source looks like it’s already unpacked.

source

fn get_pkg(&mut self, package: PackageId, path: &File) -> CargoResult<Package>

Trait Implementations§

source§

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

source§

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

Attempts to find the packages that match a dependency request.
source§

fn supports_checksums(&self) -> bool

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

fn requires_precise(&self) -> bool

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

fn source_id(&self) -> SourceId

Returns the SourceId corresponding to this source.
source§

fn invalidate_cache(&mut self)

Ensure that the source is fully up-to-date for the current session on the next query.
source§

fn set_quiet(&mut self, quiet: bool)

If quiet, the source should not display any progress or status messages.
source§

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

Fetches the full package for each name and version specified.
source§

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

source§

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

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

fn describe(&self) -> String

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

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.
source§

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

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

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

Block until all outstanding Poll::Pending requests are Poll::Ready. Read more
source§

fn replaced_source_id(&self) -> SourceId

Returns the replaced SourceId corresponding to this source.
source§

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

source§

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

source§

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

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

fn is_replaced(&self) -> bool

Returns whether a source is being replaced by another here.

Auto Trait Implementations§

§

impl<'cfg> !RefUnwindSafe for RegistrySource<'cfg>

§

impl<'cfg> !Send for RegistrySource<'cfg>

§

impl<'cfg> !Sync for RegistrySource<'cfg>

§

impl<'cfg> Unpin for RegistrySource<'cfg>

§

impl<'cfg> !UnwindSafe for RegistrySource<'cfg>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · 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> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size: 192 bytes