Struct cargo::sources::overlay::DependencyConfusionThreatOverlaySource

pub struct DependencyConfusionThreatOverlaySource<'gctx> {
    local: Box<dyn Source + 'gctx>,
    remote: Box<dyn Source + 'gctx>,
}

A Source that overlays one source over another, pretending that the packages available in the overlay are actually available in the other one.

This is a massive footgun and a terrible idea, so we do not (and never will) expose this publicly. However, it is useful for some very specific private things, like locally verifying a bunch of packages at a time before any of them have been published.

Fields

local: Box<dyn Source + 'gctx>

remote: Box<dyn Source + 'gctx>

Implementations

impl<'gctx> DependencyConfusionThreatOverlaySource<'gctx>

pub fn new( local: Box<dyn Source + 'gctx>, remote: Box<dyn Source + 'gctx>, ) -> Self

Trait Implementations

impl<'gctx> Source for DependencyConfusionThreatOverlaySource<'gctx>

fn source_id(&self) -> SourceId

Returns the 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, package: PackageId) -> CargoResult<MaybePackage>

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

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

Gives the source the downloaded .crate file.

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) -> 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 replaced_source_id(&self) -> SourceId

Returns the replaced SourceId corresponding to this source.

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.

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.

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