[go: up one dir, main page]

tame-index 0.2.1

Provides access to local and remote cargo registry indices
Documentation

📇 tame-index

Small crate for interacting with cargo registry indices

Embark Embark Crates.io Docs dependency status Build status

You probably want to use crates-index

This crate is a hard fork of crates-index to fit the use cases of cargo-deny and cargo-fetcher, if you are looking for a crate to access a cargo registry index, you would be well served by using crates-index instead.

Differences from crates-index

If you still want to use this crate instead, there are some differences to be aware of. Though note any of these may change in the future as crates-index and this crate evolve.

  1. Git registry support is optional, gated behind the git feature flag.
  2. Git functionality is provided by gix instead of git2
  3. The API exposes enough pieces where an alternative git implementation can be used if gix is not to your liking.
  4. Sparse index support is optional, gated behind the sparse feature flag.
  5. Sparse HTTP functionality is provided by the reqwest crate
  6. Support for creating HTTP requests and parsing HTTP responses is still available when the sparse feature is not enabled if you want to use a different HTTP client than reqwest
  7. Local cache files are always supported regardless of features enabled
  8. Functionality for determining the local index location for a remote registry URL is exposed in the public API
  9. Functionality for writing cache entries to the local index cache is exposed in the public API
  10. Local Registry support is available behind the local feature flag
  11. Building of local registries is available behind the local-builder feature flag

Contributing

Contributor Covenant

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

at your option.

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