Struct cargo::sources::path::RecursivePathSource

pub struct RecursivePathSource<'gctx> {
    source_id: SourceId,
    path: PathBuf,
    loaded: bool,
    packages: HashMap<PackageId, Vec<Package>>,
    warned_duplicate: HashSet<PackageId>,
    gctx: &'gctx GlobalContext,
}

A source that represents one or multiple packages gathered from a given root path on the filesystem.

Fields

source_id: SourceId

The unique identifier of this source.

path: PathBuf

The root path of this source.

loaded: bool

Whether this source has loaded all package information it may contain.

packages: HashMap<PackageId, Vec<Package>>

Packages that this sources has discovered.

Tracking all packages for a given ID to warn on-demand for unused packages

warned_duplicate: HashSet<PackageId>

Avoid redundant unused package warnings

gctx: &'gctx GlobalContext

Implementations

impl<'gctx> RecursivePathSource<'gctx>

pub fn new(root: &Path, source_id: SourceId, gctx: &'gctx GlobalContext) -> Self

Creates a new source which is walked recursively to discover packages.

This is similar to the PathSource::new method except that instead of requiring a valid package to be present at root the folder is walked entirely to crawl for packages.

Note that this should be used with care and likely shouldn’t be chosen by default!

pub fn read_packages(&mut self) -> CargoResult<Vec<Package>>

Returns the packages discovered by this source. It may walk the filesystem if package information haven’t yet loaded.

pub fn list_files(&self, pkg: &Package) -> CargoResult<Vec<PathBuf>>

List all files relevant to building this package inside this source.

This function will use the appropriate methods to determine the set of files underneath this source’s directory which are relevant for building pkg.

The basic assumption of this method is that all files in the directory are relevant for building this package, but it also contains logic to use other methods like .gitignore, package.include, or package.exclude to filter the list of files.

fn last_modified_file(&self, pkg: &Package) -> CargoResult<(FileTime, PathBuf)>

Gets the last modified file in a package.

pub fn path(&self) -> &Path

Returns the root path of this source.

pub fn load(&mut self) -> CargoResult<()>

Discovers packages inside this source if it hasn’t yet done.

Trait Implementations

impl<'gctx> Debug for RecursivePathSource<'gctx>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'gctx> Source for RecursivePathSource<'gctx>

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

Returns the SourceId corresponding to this source.

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

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

fn finish_download( &mut self, _id: PackageId, _data: 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 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 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: 144 bytes