# Struct cargo::sources::path::PathSource

source ·

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

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.

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

§`config: &'cfg Config`

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

source

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

source

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

Gets the package on the root path.

source

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

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`, `package.include`, or `package.exclude` to filter the list of files.

source

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

See `PathSource::list_files`.

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

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.

source

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

source

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

source

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

Gets the last modified file in a package.

source

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

Returns the root path of this source.

source

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

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. Read more
source§

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

Returns whether or not this source will return `Summary` items with checksums listed.
source§

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

Returns whether or not this source will return `Summary` items with the `precise` field in the `SourceId` listed.
source§

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

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

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

Starts the process to fetch a `Package` for the given `PackageId`. Read more
source§

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

Gives the source the downloaded `.crate` file. Read more
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>>>

Gathers the result from `Source::query` as a list of `Summary` items when they become available.
source§

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

Convenience method used to immediately fetch a `Package` for the given `PackageId`. Read more
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,

source§

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

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

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

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
source§

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

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

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more

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