PathSource in cargo::sources::path - Rust
Description: A source that represents a package gathered at the root path on the filesystem.

Skip to main content

## PathSource

# Struct PathSource

Source

    pub struct PathSource<'gctx> {
        source_id: SourceId,
        path: PathBuf,
        package: RefCell<Option<Package>>,
        gctx: &'gctx GlobalContext,
    }

Expand description

A source that represents a package gathered at the root path 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.

§`package: RefCell<Option<Package>>`

Packages that this sources has discovered.

§`gctx: &'gctx GlobalContext`

## Implementations§

Source§

### impl<'gctx> PathSource<'gctx>

Source

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

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 preload_with(pkg: Package, gctx: &'gctx GlobalContext) -> Self

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

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 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 load(&self) -> CargoResult<()>

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

Source

#### fn read_package(&self) -> CargoResult<Package>

## Trait Implementations§

Source§

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

Source§

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

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

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

Source§

#### fn query<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, dep: &'life1 Dependency, kind: QueryKind, f: &'life2 mut dyn FnMut(IndexSummary), ) -> Pin<Box<dyn Future<Output = CargoResult<()>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

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 `IndexSummary` items with checksums listed.
Source§

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

Returns whether or not this source will return `IndexSummary` 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<'life0, 'async_trait>( &'life0 self, id: PackageId, ) -> Pin<Box<dyn Future<Output = CargoResult<MaybePackage>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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

#### fn finish_download<'life0, 'async_trait>( &'life0 self, _id: PackageId, _data: Vec<u8>, ) -> Pin<Box<dyn Future<Output = CargoResult<Package>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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(&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<'life0, 'async_trait>( &'life0 self, _pkg: PackageId, ) -> Pin<Box<dyn Future<Output = CargoResult<bool>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Query if a package is yanked. Only registry sources can mark packages as yanked. This ignores the yanked whitelist.
Source§

#### fn invalidate_cache(&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<'life0, 'life1, 'async_trait>( &'life0 self, dep: &'life1 Dependency, kind: QueryKind, ) -> Pin<Box<dyn Future<Output = CargoResult<Vec<IndexSummary>>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Gathers the result from `Source::query` as a list of `IndexSummary` items when they become available.
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. Read more

## Auto Trait Implementations§

§

### impl<'gctx> !Freeze for PathSource<'gctx>

§

### impl<'gctx> !RefUnwindSafe for PathSource<'gctx>

§

### impl<'gctx> !Send for PathSource<'gctx>

§

### impl<'gctx> !Sync for PathSource<'gctx>

§

### impl<'gctx> Unpin for PathSource<'gctx>

§

### impl<'gctx> UnsafeUnpin for PathSource<'gctx>

§

### impl<'gctx> !UnwindSafe for PathSource<'gctx>

## Blanket Implementations§

Source§

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

Source§

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

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

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

Source§

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

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where 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 T
where 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> IntoEither for T

Source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
§

### impl<T> Pointable for T

§

#### const ALIGN: usize

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

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

Source§

#### 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 T
where U: TryFrom<T>,

Source§

#### 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<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: 56 bytes