Struct cargo::sources::replaced::ReplacedSource

pub struct ReplacedSource<'gctx> {
    to_replace: SourceId,
    replace_with: SourceId,
    inner: Box<dyn Source + 'gctx>,
}

A source that replaces one source with the other. This manages the source replacement feature.

The implementation is merely redirecting from the original to the replacement.

Fields

to_replace: SourceId

The identifier of the original source.

replace_with: SourceId

The identifier of the new replacement source.

inner: Box<dyn Source + 'gctx>

Implementations

impl<'gctx> ReplacedSource<'gctx>

pub fn new( to_replace: SourceId, replace_with: SourceId, src: Box<dyn Source + 'gctx>, ) -> ReplacedSource<'gctx>

Creates a replaced source.

The src argument is the new replacement source.

fn is_builtin_replacement(&self) -> bool

Is this source a built-in replacement of crates.io?

Built-in source replacement of crates.io for sparse registry or tests should not show messages indicating source replacement.

Trait Implementations

impl<'gctx> Source for ReplacedSource<'gctx>

fn source_id(&self) -> SourceId

Returns the SourceId corresponding to this source.

fn replaced_source_id(&self) -> SourceId

Returns the replaced SourceId corresponding to this source.

fn supports_checksums(&self) -> bool

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

fn requires_precise(&self) -> bool

Returns whether or not this source will return IndexSummary items with the precise field in the SourceId listed.

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

Attempts to find the packages that match a dependency request.

fn invalidate_cache(&mut self)

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

fn set_quiet(&mut self, quiet: bool)

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

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

Starts the process to fetch a Package for the given PackageId.

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

Gives the source the downloaded .crate file.

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

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

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

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

fn describe(&self) -> String

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

fn is_replaced(&self) -> bool

Returns whether a source is being replaced by another here.

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) -> Poll<CargoResult<bool>>

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

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

Block until all outstanding Poll::Pending requests are Poll::Ready.

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

Gathers the result from Source::query as a list of IndexSummary items when they become available.

fn download_now( self: Box<Self>, package: PackageId, gctx: &GlobalContext, ) -> CargoResult<Package>

where Self: Sized,

Convenience method used to immediately fetch a Package for the given PackageId.

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: 32 bytes