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>

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<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 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(&mut 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( &mut self, dep: &Dependency, kind: QueryKind, f: &mut dyn FnMut(IndexSummary), ) -> 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 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(&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<IndexSummary>>>

Gathers the result from 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,

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

§

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<V, T> VZip<V> for T
where 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: 48 bytes