hitbox-backend 0.2.1

Backend trait for asynchronous caching framework in Rust.
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

//! Cache Key Format Example
//!
//! Demonstrates different cache key serialization formats.
//!
//! Formats shown:
//!   - Bincode: Compact binary format (default, fastest for Redis/Tarantool)
//!   - URL-encoded: HTTP-safe format (for CDN keys, query parameters)
//!
//! Features shown:
//!   - Creating cache keys from key-value pairs
//!   - Serializing keys to different formats
//!   - Roundtrip serialization/deserialization (Bincode)
//!   - One-way serialization (URL-encoded)
//!
//! Run:
//!   cargo run -p hitbox-backend --example key_format_usage
//!
//! Expected output:
//!   Shows original key, serialized formats, and roundtrip verification.

use hitbox_backend::CacheKeyFormat;
use hitbox_core::CacheKey;

fn main() {
    // Create a cache key
    let key = CacheKey::from_slice(&[
        ("method", Some("GET")),
        ("path", Some("/api/users/123")),
        ("tenant", Some("acme-corp")),
    ]);

    println!("Original CacheKey: {:?}\n", key);

    // Demonstrate different serialization formats

    // 1. Bincode format (default, compact, fast for Redis/Tarantool)
    let bitcode_format = CacheKeyFormat::Bitcode;
    let bincode_serialized = bitcode_format.serialize(&key).unwrap();
    println!("Bincode format ({} bytes):", bincode_serialized.len());
    println!("  (binary data, not human-readable)");

    // Can deserialize back
    let bincode_deserialized = bitcode_format.deserialize(&bincode_serialized).unwrap();
    assert_eq!(key, bincode_deserialized);
    println!("  ✓ Roundtrip successful!");

    // 2. URL-encoded format (for HTTP-safe keys)
    let urlencoded_format = CacheKeyFormat::UrlEncoded;
    let urlencoded_serialized = urlencoded_format.serialize(&key).unwrap();
    println!(
        "\nURL-encoded format ({} bytes):\n  {}",
        urlencoded_serialized.len(),
        String::from_utf8_lossy(&urlencoded_serialized)
    );

    println!("\n=== Use Case Recommendations ===");
    println!("• Bincode:     Redis, Tarantool, high-performance backends (most compact, default)");
    println!("• URL-encoded: HTTP caches, CDN keys, query parameters (one-way serialization)");
}