Crate tame_index

📇 tame-index

Small crate for interacting with cargo registry indices

Differences from crates-index

1. The API exposes enough pieces where an alternative git implementation can be used if gix is not to your liking.
2. Sparse index support via reqwest is optional, gated behind the sparse feature flag.
3. Local cache files are always supported regardless of features enabled
4. ComboIndexCache (local cache files only) and ComboIndex (cache + remote capabilities) are provided to wrap git indices, sparse indices, or local registries depending on the the index URL.
5. Functionality for writing cache entries to the local index cache is exposed in the public API
6. Local Registry support is available behind the local feature flag
7. Building of local registries is available behind the local-builder feature flag
8. File-based locking compatible with Cargo is available to ensure tame-index and Cargo can play nicely together.

Contributing

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started. Please also read our Contributor Terms before you make any contributions.

Any contribution intentionally submitted for inclusion in an Embark Studios project, shall comply with the Rust standard licensing model (MIT OR Apache 2.0) and therefore be dual licensed as described below, without any additional terms or conditions:

License

This contribution is dual licensed under EITHER OF

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

For clarity, “your” refers to Embark or any other licensee/user of the contribution.

Re-exports

• pub use error::CacheError;
• pub use error::Error;
• pub use error::HttpError;
• pub use error::InvalidUrl;
• pub use error::InvalidUrlError;
• pub use index::git::CRATES_IO_INDEX;
• pub use index::sparse::CRATES_IO_HTTP_INDEX;
• pub use index::GitIndex;
• pub use index::IndexCache;
• pub use index::IndexLocation;
• pub use index::IndexPath;
• pub use index::IndexUrl;
• pub use index::SparseIndex;
• pub use krate::IndexDependency;
• pub use krate::IndexKrate;
• pub use krate::IndexVersion;

Modules

• error
  Provides the various error types for this crate
• external
  Reexports of some crates for easier downstream usage without requiring adding your own dependencies
• index
  Provides functionality for interacting with both local and remote registry indices
• krate
  Provides types for the structured metadata stored in a registry index
• utils
  Provides several useful functions for determining the disk location of a remote registry index

Structs

• KrateName
  Used to wrap user-provided strings so that bad crate names are required to be handled separately from things more outside the user control such as I/O errors
• Path
  A slice of a UTF-8 path (akin to str).
• PathBuf
  An owned, mutable UTF-8 path (akin to String).