Crate cargo_credential

Helper library for writing Cargo credential processes.

A credential process should have a struct that implements the Credential trait. The main function should be called with an instance of that struct, such as:

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

Modules

• secret 🔒

Structs

• CredentialHello
  Message sent by the credential helper on startup
• CredentialRequest
  Message sent by Cargo to the credential helper after the hello
• LoginOptions
• RegistryInfo
• Secret
  A wrapper for values that should not be printed.
• UnsupportedCredential
  Credential provider that doesn’t support any registries.

Enums

• Action
• CacheControl
• CredentialResponse
  Message sent by the credential helper
• Error
• Operation
  A record of what kind of operation is happening that we should generate a token for.

Constants

• PROTOCOL_VERSION_1
  Credential process JSON protocol version. Incrementing this version will prevent new credential providers from working with older versions of Cargo.

Traits

• Credential

Functions

• doit 🔒
• main
  Runs the credential interaction
• read_line
  Read a line of text from stdin.
• read_token
  Prompt the user for a token.
• tty
  Open stdin from the tty