credent_fs

Crates.iocredent_fs
lib.rscredent_fs
version0.4.1
sourcesrc
created_at2020-11-05 04:17:19.395618
updated_at2021-04-04 23:09:38.616326
descriptionReads / Writes credentials from / to disk.
homepage
repositoryhttps://github.com/azriel91/credent
max_upload_size
id308796
size29,498
Azriel Hoh (azriel91)

documentation

https://docs.rs/credent/

README

🔑 Credent

Crates.io CI Coverage Status

Manages ~/.config/<app>/credentials.

Usage

Add the following to Cargo.toml:

credent = { version = "0.4.1", features = ["backend-smol"] } # or "backend-tokio"

Example code:

use credent::{
    cli::CredentialsCliReader,
    fs::{model::AppName, CredentialsFile, CredentialsFileStorer},
    model::Credentials,
};

/// Application name
const CREDENT: AppName<'_> = AppName("credent");

fn main() -> Result<(), Box<dyn std::error::Error>> {
    smol::run(async {
        let credentials = CredentialsCliReader::<Credentials>::read_from_tty().await?;
        println!("credentials: {}", credentials);

        CredentialsFileStorer::<Credentials>::store(CREDENT, &credentials).await?;

        println!(
            "credentials written to: {}",
            CredentialsFile::<Credentials>::path(CREDENT)?.display()
        );

        Result::<(), Box<dyn std::error::Error>>::Ok(())
    })
}

More examples can be seen in the examples.

# Use either "backend-smol" or "backend-tokio"
cargo run --features "backend-smol" --example simple
cargo run --features "backend-smol" --example demo
cargo run --features "backend-smol" --example profiles
cargo run --features "backend-smol" --example profiles -- --profile development

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 88

cargo fmt