DependencyConfusionThreatOverlaySource in cargo::sources::overlay - Rust
Description: A `Source` that overlays one source over another, pretending that the packages available in the overlay are actually available in the other one.

Skip to main content

## DependencyConfusionThreatOverlaySource

# Struct DependencyConfusionThreatOverlaySource

Source

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

Expand description

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§

Source§

### impl<'gctx> DependencyConfusionThreatOverlaySource<'gctx>

Source

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

## Trait Implementations§

Source§

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

Source§

#### fn source_id(&self) -> SourceId

Returns the `SourceId` corresponding to this source.
Source§

#### fn supports_checksums(&self) -> bool

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

#### fn requires_precise(&self) -> bool

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

#### fn query<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, dep: &'life1 Dependency, kind: QueryKind, f: &'life2 mut dyn FnMut(IndexSummary), ) -> Pin<Box<dyn Future<Output = CargoResult<()>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Attempts to find the packages that match a dependency request. Read more
Source§

#### fn invalidate_cache(&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(&self, package: PackageId) -> CargoResult<MaybePackage>

Starts the process to fetch a `Package` for the given `PackageId`. Read more
Source§

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

Gives the source the downloaded `.crate` file. Read more
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(&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<'life0, 'async_trait>( &'life0 self, pkg: PackageId, ) -> Pin<Box<dyn Future<Output = CargoResult<bool>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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

#### fn replaced_source_id(&self) -> SourceId

Returns the replaced `SourceId` corresponding to this source.
Source§

#### fn query_vec<'life0, 'life1, 'async_trait>( &'life0 self, dep: &'life1 Dependency, kind: QueryKind, ) -> Pin<Box<dyn Future<Output = CargoResult<Vec<IndexSummary>>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Gathers the result from `Source::query` as a list of `IndexSummary` items when they become available.
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. Read more

## Auto Trait Implementations§

§

### impl<'gctx> Freeze for DependencyConfusionThreatOverlaySource<'gctx>

§

### impl<'gctx> !RefUnwindSafe for DependencyConfusionThreatOverlaySource<'gctx>

§

### impl<'gctx> !Send for DependencyConfusionThreatOverlaySource<'gctx>

§

### impl<'gctx> !Sync for DependencyConfusionThreatOverlaySource<'gctx>

§

### impl<'gctx> Unpin for DependencyConfusionThreatOverlaySource<'gctx>

§

### impl<'gctx> UnsafeUnpin for DependencyConfusionThreatOverlaySource<'gctx>

§

### impl<'gctx> !UnwindSafe for DependencyConfusionThreatOverlaySource<'gctx>

## 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> 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> Pointable for T

§

#### const ALIGN: usize

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
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

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