Struct cargo::sources::path::PathSource
source · pub struct PathSource<'gctx> {
source_id: SourceId,
path: PathBuf,
package: 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: Option<Package>
Packages that this sources has discovered.
gctx: &'gctx GlobalContext
Implementations§
source§impl<'gctx> PathSource<'gctx>
impl<'gctx> PathSource<'gctx>
sourcepub fn new(path: &Path, source_id: SourceId, gctx: &'gctx GlobalContext) -> Self
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
.
sourcepub fn preload_with(pkg: Package, gctx: &'gctx GlobalContext) -> Self
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.
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 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.
sourcefn last_modified_file(&self, pkg: &Package) -> CargoResult<(FileTime, PathBuf)>
fn last_modified_file(&self, pkg: &Package) -> CargoResult<(FileTime, PathBuf)>
Gets the last modified file in a package.
sourcepub fn load(&mut self) -> CargoResult<()>
pub fn load(&mut self) -> CargoResult<()>
Discovers packages inside this source if it hasn’t yet done.
fn read_package(&self) -> CargoResult<Package>
Trait Implementations§
source§impl<'gctx> Debug for PathSource<'gctx>
impl<'gctx> Debug for PathSource<'gctx>
source§impl<'gctx> Source for PathSource<'gctx>
impl<'gctx> Source for PathSource<'gctx>
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.source§fn download_now(
self: Box<Self>,
package: PackageId,
gctx: &GlobalContext,
) -> CargoResult<Package>where
Self: Sized,
fn download_now(
self: Box<Self>,
package: PackageId,
gctx: &GlobalContext,
) -> 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<'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> !UnwindSafe for PathSource<'gctx>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
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: 48 bytes