tree: 7107729803b26de4681f97962019e8bae10bd591 [path history] [tgz]
  1. examples/
  2. src/
  3. tests/
  4. Cargo.toml
  5. README.md
src/tools/cargo/credential/cargo-credential/README.md

cargo-credential

This package is a library to assist writing a Cargo credential helper, which provides an interface to store tokens for authorizing access to a registry such as https://crates.io/.

Documentation about credential processes may be found at https://doc.rust-lang.org/nightly/cargo/reference/credential-provider-protocol.html

Example implementations may be found at https://github.com/rust-lang/cargo/tree/master/credential

This crate is maintained by the Cargo team for use by the wider ecosystem. This crate follows semver compatibility for its APIs.

Usage

Create a Cargo project with this as a dependency:

# Add this to your Cargo.toml:

[dependencies]
cargo-credential = "0.4"

And then include a main.rs binary which implements the Credential trait, and calls the main function which will call the appropriate method of the trait:

// src/main.rs

use cargo_credential::{Credential, Error};

struct MyCredential;

impl Credential for MyCredential {
    /// implement trait methods here...
}

fn main() {
    cargo_credential::main(MyCredential);
}