#information #io #metadata #access #null

krate

Get information and metadata for published Rust crates

6 releases (1 stable)

1.0.0 Feb 3, 2023
0.4.1 Feb 1, 2023
0.4.0 Jan 30, 2023
0.3.0 Jan 29, 2023
0.1.0 Jan 29, 2023

#17 in #null

30 downloads per month

MIT license

13KB
271 lines

krate 📦

Asynchonously get information and metadata for a Rust Crate published on Crates.io!

krate additionally comes with struct Krate which contains a partially implemented data model for the &Crates.io API/V1 Contract.

NOTE: Currently there is no publically docuemented API contract for the Crates.io API/V1 Contract so any changes or null values passed via the API could break serialization. 🤷‍♂️

Please see the crawler policy on Crates.io if you are planning to use this library to crawl or access the crates data.

Usage

$> cargo add krate

main.rs

use krate::KrateClientBuilder;

#[tokio::main]
async fn main() {
    // Create a KrateClient
    let client = KrateClientBuilder::new("My User Agent Tool")
        .build_async()
        .unwrap();
    
    match client.get_async("serde").await {
        Ok(serde_crate) => {
            println!("Krate: {}", serde_crate.krate.name);
            println!("Latest Version: {}", serde_crate.get_latest());
            println!("Description: {}", serde_crate.krate.description );
        },
        Err(e) => println!("Error: {e}"),
    }    
}

This is a very small implementation! For more robust client see @TheDuke's crates-io-api

Dependencies

~4–17MB
~229K SLoC