Struct cargo::sources::registry::RegistrySource
source · pub struct RegistrySource<'cfg> { /* private fields */ }
Expand description
A Source
implementation for a local or a remote registry.
This contains common functionality that is shared between each registry
kind, with the registry-specific logic implemented as part of the
RegistryData
trait referenced via the ops
field.
For general concepts of registries, see the module-level documentation.
Implementations§
source§impl<'cfg> RegistrySource<'cfg>
impl<'cfg> RegistrySource<'cfg>
sourcepub fn remote(
source_id: SourceId,
yanked_whitelist: &HashSet<PackageId>,
config: &'cfg Config
) -> CargoResult<RegistrySource<'cfg>>
pub fn remote( source_id: SourceId, yanked_whitelist: &HashSet<PackageId>, config: &'cfg Config ) -> CargoResult<RegistrySource<'cfg>>
Creates a Source
of a “remote” registry.
It could be either an HTTP-based [http_remote::HttpRegistry
] or
a Git-based [remote::RemoteRegistry
].
yanked_whitelist
— Packages allowed to be used, even if they are yanked.
sourcepub fn local(
source_id: SourceId,
path: &Path,
yanked_whitelist: &HashSet<PackageId>,
config: &'cfg Config
) -> RegistrySource<'cfg>
pub fn local( source_id: SourceId, path: &Path, yanked_whitelist: &HashSet<PackageId>, config: &'cfg Config ) -> RegistrySource<'cfg>
Creates a Source
of a local registry, with [local::LocalRegistry
] under the hood.
path
— The root path of a local registry on the file system.yanked_whitelist
— Packages allowed to be used, even if they are yanked.
sourcepub fn config(&mut self) -> Poll<CargoResult<Option<RegistryConfig>>>
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.
Trait Implementations§
source§impl<'cfg> Source for RegistrySource<'cfg>
impl<'cfg> Source for RegistrySource<'cfg>
source§fn query(
&mut self,
dep: &Dependency,
kind: QueryKind,
f: &mut dyn FnMut(Summary)
) -> Poll<CargoResult<()>>
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. Read more
source§fn supports_checksums(&self) -> bool
fn supports_checksums(&self) -> bool
Returns whether or not this source will return
Summary
items with
checksums listed.source§fn requires_precise(&self) -> bool
fn requires_precise(&self) -> bool
source§fn invalidate_cache(&mut self)
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)
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>
fn download(&mut self, package: PackageId) -> CargoResult<MaybePackage>
source§fn finish_download(
&mut self,
package: PackageId,
data: Vec<u8>
) -> CargoResult<Package>
fn finish_download( &mut self, package: PackageId, data: Vec<u8> ) -> CargoResult<Package>
Gives the source the downloaded
.crate
file. Read moresource§fn fingerprint(&self, pkg: &Package) -> CargoResult<String>
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
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])
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>>
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<()>
fn block_until_ready(&mut self) -> CargoResult<()>
source§fn replaced_source_id(&self) -> SourceId
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>>>
fn query_vec( &mut self, dep: &Dependency, kind: QueryKind ) -> Poll<CargoResult<Vec<Summary>>>
Gathers the result from
Source::query
as a list of Summary
items
when they become available.source§fn download_now(
self: Box<Self>,
package: PackageId,
config: &Config
) -> CargoResult<Package>where
Self: Sized,
fn download_now(
self: Box<Self>,
package: PackageId,
config: &Config
) -> CargoResult<Package>where
Self: Sized,
source§fn verify(&self, _pkg: PackageId) -> CargoResult<()>
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
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more