# 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>

source

#### 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`.

source

#### 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!

source

#### pub fn preload_with(&mut self, pkg: Package)

source

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

source

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

source

#### 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.

source

#### fn _list_files(&self, pkg: &Package) -> CargoResult<Vec<PathBuf>>

source

#### 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.

source

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

source

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

source

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

source

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

source

#### pub fn path(&self) -> &Path

source

#### pub fn update(&mut self) -> CargoResult<()>

## Trait Implementations§

source§

### impl<'cfg> Debug for PathSource<'cfg>

source§

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

Formats the value using the given formatter. Read more
source§

### impl<'cfg> Source for PathSource<'cfg>

source§

#### 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.
source§

#### fn supports_checksums(&self) -> bool

Returns whether or not this source will return summaries with checksums listed.
source§

#### fn requires_precise(&self) -> bool

Returns whether or not this source will return summaries with the `precise` field in the source id listed.
source§

#### fn source_id(&self) -> SourceId

Returns the `SourceId` corresponding to this source.
source§

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

Fetches the full package for each name and version specified.
source§

#### fn finish_download( &mut self, _id: PackageId, _data: Vec<u8> ) -> CargoResult<Package>

source§

#### fn fingerprint(&self, pkg: &Package) -> CargoResult<String>

Generates a unique string which represents the fingerprint of the current state of the source. Read more
source§

#### fn describe(&self) -> String

Describes this source in a human readable fashion, used for display in resolver error messages currently.
source§

#### 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.
source§

#### 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.
source§

#### fn block_until_ready(&mut self) -> CargoResult<()>

Block until all outstanding Poll::Pending requests are `Poll::Ready`. Read more
source§

#### fn invalidate_cache(&mut self)

Ensure that the source is fully up-to-date for the current session on the next query.
source§

#### fn set_quiet(&mut self, _quiet: bool)

If quiet, the source should not display any progress or status messages.
source§

#### fn replaced_source_id(&self) -> SourceId

Returns the replaced `SourceId` corresponding to this source.
source§

#### fn query_vec( &mut self, dep: &Dependency, kind: QueryKind ) -> Poll<CargoResult<Vec<Summary>>>

source§

#### fn download_now( self: Box<Self>, package: PackageId, config: &Config ) -> CargoResult<Package>where Self: Sized,

source§

#### fn verify(&self, _pkg: PackageId) -> CargoResult<()>

If this source supports it, verifies the source of the package specified. Read more
source§

#### fn is_replaced(&self) -> bool

Returns whether a source is being replaced by another here.

## 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§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

const: unstable · source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T> Same<T> for T

§

#### type Output = T

Should always be `Self`
source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

#### fn vzip(self) -> V

## 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