Struct cargo::sources::path::PathSource

pub struct PathSource<'gctx> {
    source_id: SourceId,
    path: PathBuf,
    updated: bool,
    packages: Vec<Package>,
    recursive: bool,
    gctx: &'gctx GlobalContext,
}

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

It’s the cornerstone of every other source — other implementations eventually need to call PathSource to read local packages somewhere on the filesystem.

It also provides convenient methods like PathSource::list_files to list all files in a package, given its ability to walk the filesystem.

Fields

source_id: SourceId

The unique identifier of this source.

path: PathBuf

The root path of this source.

updated: bool

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

packages: Vec<Package>

Packages that this sources has discovered.

recursive: bool

Whether this source should discover nested packages recursively. See PathSource::new_recursive for more.

gctx: &'gctx GlobalContext

Implementations

impl<'gctx> PathSource<'gctx>

pub fn new( path: &Path, source_id: SourceId, gctx: &'gctx GlobalContext ) -> PathSource<'gctx>

Invoked with an absolute path to a directory that contains a Cargo.toml.

This source will only return the package at precisely the path specified, and it will be an error if there’s not a package at path.

pub fn new_recursive( root: &Path, id: SourceId, gctx: &'gctx GlobalContext ) -> PathSource<'gctx>

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 preload_with(&mut self, pkg: Package)

Preloads a package for this source. The source is assumed that it has yet loaded any other packages.

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

Gets the package on the root path.

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

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

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 _list_files(&self, pkg: &Package) -> CargoResult<Vec<PathBuf>>

See PathSource::list_files.

fn discover_git_repo(&self, root: &Path) -> CargoResult<Option<Repository>>

Returns Some(git2::Repository) if found sibling Cargo.toml and .git directory; otherwise, caller should fall back on full file list.

fn discover_gix_repo(&self, root: &Path) -> CargoResult<Option<Repository>>

Returns Some(gix::Repository) if the discovered repository (searched upwards from root) contains a tracked <root>/Cargo.toml. Otherwise, the caller should fall back on full file list.

fn list_files_git( &self, pkg: &Package, repo: &Repository, filter: &dyn Fn(&Path, bool) -> bool ) -> CargoResult<Vec<PathBuf>>

Lists files relevant to building this package inside this source by consulting both Git index (tracked) or status (untracked) under a given Git repository.

This looks into Git submodules as well.

fn list_files_gix( &self, pkg: &Package, repo: &Repository, filter: &dyn Fn(&Path, bool) -> bool ) -> CargoResult<Vec<PathBuf>>

Lists files relevant to building this package inside this source by traversing the git working tree, while avoiding ignored files.

This looks into Git sub-repositories as well, resolving them to individual files. Symlinks to directories will also be resolved, but walked as repositories if they point to one to avoid picking up .git directories.

fn list_files_walk( &self, pkg: &Package, filter: &dyn Fn(&Path, bool) -> bool ) -> CargoResult<Vec<PathBuf>>

Lists files relevant to building this package inside this source by walking the filesystem from the package root path.

This is a fallback for PathSource::list_files_git when the package is not tracked under a Git repository.

fn walk( &self, path: &Path, ret: &mut Vec<PathBuf>, is_root: bool, filter: &dyn Fn(&Path, bool) -> bool ) -> CargoResult<()>

Helper recursive function for PathSource::list_files_walk.

pub 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 update(&mut self) -> CargoResult<()>

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

Trait Implementations

impl<'gctx> Debug for PathSource<'gctx>

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

Formats the value using the given formatter.

impl<'gctx> Source for PathSource<'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: 72 bytes