Struct cargo::sources::path::PathSource
source · pub struct PathSource<'cfg> {
source_id: SourceId,
path: PathBuf,
updated: bool,
packages: Vec<Package>,
config: &'cfg Config,
recursive: bool,
}
Fields§
§source_id: SourceId
§path: PathBuf
§updated: bool
§packages: Vec<Package>
§config: &'cfg Config
§recursive: bool
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 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)
pub fn root_package(&mut self) -> CargoResult<Package>
pub fn read_packages(&self) -> CargoResult<Vec<Package>>
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 to filter the list of files.
fn _list_files(&self, pkg: &Package) -> CargoResult<Vec<PathBuf>>
sourcefn discover_git_repo(&self, root: &Path) -> CargoResult<Option<Repository>>
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 list_files_git( &self, pkg: &Package, repo: &Repository, filter: &dyn Fn(&Path, bool) -> bool ) -> CargoResult<Vec<PathBuf>>
fn list_files_walk( &self, pkg: &Package, filter: &dyn Fn(&Path, bool) -> bool ) -> CargoResult<Vec<PathBuf>>
fn walk( &self, path: &Path, ret: &mut Vec<PathBuf>, is_root: bool, filter: &dyn Fn(&Path, bool) -> bool ) -> CargoResult<()>
pub fn last_modified_file( &self, pkg: &Package ) -> CargoResult<(FileTime, PathBuf)>
pub fn path(&self) -> &Path
pub fn update(&mut self) -> CargoResult<()>
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(Summary)
) -> Poll<CargoResult<()>>
fn query( &mut self, dep: &Dependency, kind: QueryKind, f: &mut dyn FnMut(Summary) ) -> Poll<CargoResult<()>>
source§fn supports_checksums(&self) -> bool
fn supports_checksums(&self) -> bool
source§fn requires_precise(&self) -> bool
fn requires_precise(&self) -> bool
precise
field in the source id listed.source§fn download(&mut self, id: PackageId) -> CargoResult<MaybePackage>
fn download(&mut self, id: PackageId) -> CargoResult<MaybePackage>
fn finish_download( &mut self, _id: PackageId, _data: Vec<u8> ) -> CargoResult<Package>
source§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<()>
Poll::Ready
. Read moresource§fn invalidate_cache(&mut self)
fn invalidate_cache(&mut self)
source§fn replaced_source_id(&self) -> SourceId
fn replaced_source_id(&self) -> SourceId
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,
source§fn verify(&self, _pkg: PackageId) -> CargoResult<()>
fn verify(&self, _pkg: PackageId) -> CargoResult<()>
source§fn is_replaced(&self) -> bool
fn is_replaced(&self) -> bool
Auto Trait Implementations§
impl<'cfg> !RefUnwindSafe for PathSource<'cfg>
impl<'cfg> !Send for PathSource<'cfg>
impl<'cfg> !Sync for PathSource<'cfg>
impl<'cfg> Unpin for PathSource<'cfg>
impl<'cfg> !UnwindSafe for PathSource<'cfg>
Blanket Implementations§
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