Struct cargo::sources::path::PathSource

pub struct PathSource<'cfg> { /* fields omitted */ }

Methods

impl<'cfg> PathSource<'cfg>

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.

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

pub fn preload_with(&mut self, pkg: Package)

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

pub fn read_packages(&self) -> CargoResult<Vec<Package>>

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 to filter the list of files.

Pattern matching strategy

Migrating from a glob-like pattern matching (using glob crate) to a gitignore-like pattern matching (using ignore crate). The migration stages are:

1. Only warn users about the future change iff their matching rules are affected. (CURRENT STAGE)

2. Switch to the new strategy and update documents. Still keep warning affected users.

3. Drop the old strategy and no more warnings.

See https://github.com/rust-lang/cargo/issues/4268 for more info.

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

pub fn path(&self) -> &Path

Trait Implementations

impl<'cfg> Source for PathSource<'cfg>

fn query(
    &mut self,
    dep: &Dependency,
    f: &mut dyn FnMut(Summary)
) -> CargoResult<()>

Attempt to find the packages that match a dependency request.

fn fuzzy_query(
    &mut self,
    _dep: &Dependency,
    f: &mut dyn FnMut(Summary)
) -> CargoResult<()>

Attempt to find the packages that are close to a dependency request. Each source gets to define what close means for it. path/git sources may return all dependencies that are at that uri. where as an Index source may return dependencies that have the same canonicalization.

fn supports_checksums(&self) -> bool

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

fn requires_precise(&self) -> bool

Returns whether or not this source will return summaries with the precise field in the source id listed.

fn source_id(&self) -> SourceId

Returns the SourceId corresponding to this source

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

The update method performs any network operations required to get the entire list of all names, versions and dependencies of packages managed by the Source.

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

The download method fetches the full package for each name and version specified.

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

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

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

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 replaced_source_id(&self) -> SourceId

Returns the replaced SourceId corresponding to this source

fn query_vec(&mut self, dep: &Dependency) -> CargoResult<Vec<Summary>>

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

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

fn is_replaced(&self) -> bool

Returns whether a source is being replaced by another here

impl<'cfg> Debug for PathSource<'cfg>

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

Formats the value using the given formatter.