api-bones 4.0.0

Opinionated REST API types: errors (RFC 9457), pagination, health checks, and more
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

//! Rate limit metadata types.
//!
//! Demonstrates `RateLimitInfo` for tracking API quota state,
//! including the `retry_after` hint for 429 responses.
//!
//! Run: `cargo run --example rate_limit`

use api_bones::RateLimitInfo;

fn main() {
    // -- Within quota --
    let ok = RateLimitInfo::new(100, 42, 1_700_000_000);
    println!("Within quota:");
    println!(
        "  limit={}, remaining={}, reset={}, exceeded={}",
        ok.limit,
        ok.remaining,
        ok.reset,
        ok.is_exceeded()
    );
    print_json("  ", &ok);

    // -- Exceeded with retry_after --
    let exceeded = RateLimitInfo::new(100, 0, 1_700_000_000).retry_after(60);
    println!("\nExceeded:");
    println!(
        "  limit={}, remaining={}, exceeded={}, retry_after={:?}",
        exceeded.limit,
        exceeded.remaining,
        exceeded.is_exceeded(),
        exceeded.retry_after
    );
    print_json("  ", &exceeded);
}

fn print_json(prefix: &str, value: &impl serde::Serialize) {
    let json = serde_json::to_string_pretty(value).expect("serialization");
    for line in json.lines() {
        println!("{prefix}{line}");
    }
}