Struct cargo::sources::path::PathSource
source · pub struct PathSource<'cfg> { /* private fields */ }
Expand description
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.
Implementations§
source§impl<'cfg> PathSource<'cfg>
impl<'cfg> PathSource<'cfg>
sourcepub fn new(
path: &Path,
source_id: SourceId,
config: &'cfg Config
) -> PathSource<'cfg>
pub fn new( path: &Path, source_id: SourceId, config: &'cfg Config ) -> PathSource<'cfg>
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
.
sourcepub fn new_recursive(
root: &Path,
id: SourceId,
config: &'cfg Config
) -> PathSource<'cfg>
pub fn new_recursive( root: &Path, id: SourceId, config: &'cfg Config ) -> PathSource<'cfg>
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!
sourcepub fn preload_with(&mut self, pkg: Package)
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.
sourcepub fn root_package(&mut self) -> CargoResult<Package>
pub fn root_package(&mut self) -> CargoResult<Package>
Gets the package on the root path.
sourcepub fn read_packages(&self) -> CargoResult<Vec<Package>>
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.
sourcepub fn list_files(&self, pkg: &Package) -> CargoResult<Vec<PathBuf>>
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.
sourcepub fn last_modified_file(
&self,
pkg: &Package
) -> CargoResult<(FileTime, PathBuf)>
pub fn last_modified_file( &self, pkg: &Package ) -> CargoResult<(FileTime, PathBuf)>
Gets the last modified file in a package.
sourcepub fn update(&mut self) -> CargoResult<()>
pub fn update(&mut self) -> CargoResult<()>
Discovers packages inside this source if it hasn’t yet done.
Trait Implementations§
source§impl<'cfg> Debug for PathSource<'cfg>
impl<'cfg> Debug for PathSource<'cfg>
source§impl<'cfg> Source for PathSource<'cfg>
impl<'cfg> Source for PathSource<'cfg>
source§fn query(
&mut self,
dep: &Dependency,
kind: QueryKind,
f: &mut dyn FnMut(IndexSummary)
) -> Poll<CargoResult<()>>
fn query( &mut self, dep: &Dependency, kind: QueryKind, f: &mut dyn FnMut(IndexSummary) ) -> Poll<CargoResult<()>>
source§fn supports_checksums(&self) -> bool
fn supports_checksums(&self) -> bool
IndexSummary
items with
checksums listed.source§fn requires_precise(&self) -> bool
fn requires_precise(&self) -> bool
IndexSummary
items with
the precise
field in the SourceId
listed.source§fn download(&mut self, id: PackageId) -> CargoResult<MaybePackage>
fn download(&mut self, id: PackageId) -> CargoResult<MaybePackage>
source§fn finish_download(
&mut self,
_id: PackageId,
_data: Vec<u8>
) -> CargoResult<Package>
fn finish_download( &mut self, _id: PackageId, _data: Vec<u8> ) -> CargoResult<Package>
.crate
file. Read moresource§fn fingerprint(&self, pkg: &Package) -> CargoResult<String>
fn fingerprint(&self, pkg: &Package) -> CargoResult<String>
source§fn describe(&self) -> String
fn describe(&self) -> String
source§fn add_to_yanked_whitelist(&mut self, _pkgs: &[PackageId])
fn add_to_yanked_whitelist(&mut self, _pkgs: &[PackageId])
source§fn is_yanked(&mut self, _pkg: PackageId) -> Poll<CargoResult<bool>>
fn is_yanked(&mut self, _pkg: PackageId) -> Poll<CargoResult<bool>>
source§fn block_until_ready(&mut self) -> CargoResult<()>
fn block_until_ready(&mut self) -> CargoResult<()>
source§fn invalidate_cache(&mut self)
fn invalidate_cache(&mut self)
source§fn set_quiet(&mut self, _quiet: bool)
fn set_quiet(&mut self, _quiet: bool)
source§fn replaced_source_id(&self) -> SourceId
fn replaced_source_id(&self) -> SourceId
SourceId
corresponding to this source.source§fn query_vec(
&mut self,
dep: &Dependency,
kind: QueryKind
) -> Poll<CargoResult<Vec<IndexSummary>>>
fn query_vec( &mut self, dep: &Dependency, kind: QueryKind ) -> Poll<CargoResult<Vec<IndexSummary>>>
Source::query
as a list of IndexSummary
items
when they become available.