Struct cargo::sources::directory::DirectorySource

pub struct DirectorySource<'cfg> { /* private fields */ }

DirectorySource contains a number of crates on the file system. It was designed for representing vendored dependencies for cargo vendor.

DirectorySource at this moment is just a root directory containing other directories, which contain the source files of packages. Assumptions would be made to determine if a directory should be included as a package of a directory source’s:

• Ignore directories starting with dot . (tend to be hidden).
• Only when a Cargo.toml exists in a directory will it be included as a package. DirectorySource at this time only looks at one level of directories and never went deeper.
• There must be a [Checksum] file .cargo-checksum.json file at the same level of Cargo.toml to ensure the integrity when a directory source was created (usually by cargo vendor). A failure to find or parse a single checksum results in a denial of loading any package in this source.
• Otherwise, there is no other restrction of the name of directories. At this moment, it is cargo vendor that defines the layout and the name of each directory.

The file tree of a directory source may look like:

[source root]
├── a-valid-crate/
│  ├── src/
│  ├── .cargo-checksum.json
│  └── Cargo.toml
├── .ignored-a-dot-crate/
│  ├── src/
│  ├── .cargo-checksum.json
│  └── Cargo.toml
├── skipped-no-manifest/
│  ├── src/
│  └── .cargo-checksum.json
└── no-checksum-so-fails-the-entire-source-reading/
   └── Cargo.toml

Implementations

impl<'cfg> DirectorySource<'cfg>

pub fn new( path: &Path, id: SourceId, config: &'cfg Config ) -> DirectorySource<'cfg>

Trait Implementations

impl<'cfg> Debug for DirectorySource<'cfg>

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

Formats the value using the given formatter.

impl<'cfg> Source for DirectorySource<'cfg>

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.

fn supports_checksums(&self) -> bool

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

fn requires_precise(&self) -> bool

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

fn source_id(&self) -> SourceId

Returns the SourceId corresponding to this source.

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

Block until all outstanding Poll::Pending requests are Poll::Ready.

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

Starts the process to fetch a Package for the given PackageId.

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

Gives the source the downloaded .crate file.

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

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

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

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

fn describe(&self) -> String

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

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.

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.

fn invalidate_cache(&mut self)

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

fn set_quiet(&mut self, _quiet: bool)

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

fn replaced_source_id(&self) -> SourceId

Returns the replaced SourceId corresponding to this 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.

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.

fn is_replaced(&self) -> bool

Returns whether a source is being replaced by another here.