Trait cargo::core::source::Source

pub trait Source {
    // Required methods
    fn source_id(&self) -> SourceId;
    fn supports_checksums(&self) -> bool;
    fn requires_precise(&self) -> bool;
    fn query(
        &mut self,
        dep: &Dependency,
        kind: QueryKind,
        f: &mut dyn FnMut(Summary)
    ) -> Poll<CargoResult<()>>;
    fn invalidate_cache(&mut self);
    fn download(&mut self, package: PackageId) -> CargoResult<MaybePackage>;
    fn finish_download(
        &mut self,
        package: PackageId,
        contents: Vec<u8>
    ) -> CargoResult<Package>;
    fn fingerprint(&self, pkg: &Package) -> CargoResult<String>;
    fn describe(&self) -> String;
    fn add_to_yanked_whitelist(&mut self, pkgs: &[PackageId]);
    fn is_yanked(&mut self, _pkg: PackageId) -> Poll<CargoResult<bool>>;
    fn block_until_ready(&mut self) -> CargoResult<()>;

    // Provided methods
    fn replaced_source_id(&self) -> SourceId { ... }
    fn query_vec(
        &mut self,
        dep: &Dependency,
        kind: QueryKind
    ) -> Poll<CargoResult<Vec<Summary>>> { ... }
    fn download_now(
        self: Box<Self>,
        package: PackageId,
        config: &Config
    ) -> CargoResult<Package>
       where Self: Sized { ... }
    fn verify(&self, _pkg: PackageId) -> CargoResult<()> { ... }
    fn is_replaced(&self) -> bool { ... }
}

Something that finds and downloads remote packages based on names and versions.

Required Methods

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 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 query( &mut self, dep: &Dependency, kind: QueryKind, f: &mut dyn FnMut(Summary) ) -> 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 download(&mut self, package: PackageId) -> CargoResult<MaybePackage>

Fetches the full package for each name and version specified.

fn finish_download( &mut self, package: PackageId, contents: 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.

This fingerprint is used to determine the “freshness” of the source later on. It must be guaranteed that the fingerprint of a source is constant if and only if the output product will remain constant.

The pkg argument is the package which this fingerprint should only be interested in for when this source may contain multiple packages.

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.

After calling this function, the source should return Poll::Ready for any queries that previously returned Poll::Pending.

If no queries previously returned Poll::Pending, and invalidate_cache was not called, this function should be a no-op.

Provided Methods

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

Note that the source may also have performed other checksum-based verification during the download step, but this is intended to be run just before a crate is compiled so it may perform more expensive checks which may not be cacheable.

fn is_replaced(&self) -> bool

Returns whether a source is being replaced by another here.

Implementations on Foreign Types

impl<'a, T: Source + ?Sized + 'a> Source for &'a mut T

fn source_id(&self) -> SourceId

fn replaced_source_id(&self) -> SourceId

fn supports_checksums(&self) -> bool

fn requires_precise(&self) -> bool

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

fn invalidate_cache(&mut self)

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

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

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

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

fn describe(&self) -> String

fn is_replaced(&self) -> bool

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

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

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

impl<'a, T: Source + ?Sized + 'a> Source for Box<T>

fn source_id(&self) -> SourceId

Forwards to Source::source_id.

fn replaced_source_id(&self) -> SourceId

Forwards to Source::replaced_source_id.

fn supports_checksums(&self) -> bool

Forwards to Source::supports_checksums.

fn requires_precise(&self) -> bool

Forwards to Source::requires_precise.

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

Forwards to Source::query.

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

Forwards to Source::download.

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

Forwards to Source::fingerprint.

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

Forwards to Source::verify.

fn invalidate_cache(&mut self)

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

fn describe(&self) -> String

fn is_replaced(&self) -> bool

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

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

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

Implementors

impl<'cfg> Source for DirectorySource<'cfg>

impl<'cfg> Source for GitSource<'cfg>

impl<'cfg> Source for PathSource<'cfg>

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

impl<'cfg> Source for ReplacedSource<'cfg>