pub struct RegistrySource<'cfg> { /* private fields */ }
Expand description
A “source” for a local (see local::LocalRegistry
) or remote (see
remote::RemoteRegistry
) registry.
This contains common functionality that is shared between the two registry
kinds, with the registry-specific logic implemented as part of the
RegistryData
trait referenced via the ops
field.
Implementations
sourceimpl<'cfg> RegistrySource<'cfg>
impl<'cfg> RegistrySource<'cfg>
pub fn remote(
source_id: SourceId,
yanked_whitelist: &HashSet<PackageId>,
config: &'cfg Config
) -> CargoResult<RegistrySource<'cfg>>
pub fn local(
source_id: SourceId,
path: &Path,
yanked_whitelist: &HashSet<PackageId>,
config: &'cfg Config
) -> RegistrySource<'cfg>
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
sourceimpl<'cfg> Source for RegistrySource<'cfg>
impl<'cfg> Source for RegistrySource<'cfg>
sourcefn 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.
sourcefn supports_checksums(&self) -> bool
fn supports_checksums(&self) -> bool
Returns whether or not this source will return summaries with checksums listed. Read more
sourcefn requires_precise(&self) -> bool
fn requires_precise(&self) -> bool
Returns whether or not this source will return summaries with
the precise
field in the source id listed. Read more
sourcefn 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.
sourcefn download(&mut self, package: PackageId) -> CargoResult<MaybePackage>
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,
data: Vec<u8>
) -> CargoResult<Package>
sourcefn 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
sourcefn describe(&self) -> String
fn describe(&self) -> String
Describes this source in a human readable fashion, used for display in resolver error messages currently. Read more
sourcefn 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. Read more
sourcefn 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. Read more
sourcefn block_until_ready(&mut self) -> CargoResult<()>
fn block_until_ready(&mut self) -> CargoResult<()>
Block until all outstanding Poll::Pending requests are Poll::Ready
. Read more
sourcefn replaced_source_id(&self) -> SourceId
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,
sourcefn 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
sourcefn 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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more