inferadb 0.1.5

Official Rust SDK for InferaDB
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! User-Agent header generation for SDK telemetry.
//!
//! Provides a consistent User-Agent string across all transports (REST and gRPC)
//! to help with usage analytics, debugging, and deprecation planning.

use std::sync::OnceLock;

/// SDK name used in the User-Agent string.
const SDK_NAME: &str = "inferadb-rust";

/// SDK version from Cargo.toml.
const SDK_VERSION: &str = env!("CARGO_PKG_VERSION");

/// Cached User-Agent string (computed once on first access).
static USER_AGENT: OnceLock<String> = OnceLock::new();

/// Returns the User-Agent string for SDK requests.
///
/// Format: `inferadb-rust/0.1.0 (rust/1.75.0; darwin/aarch64)`
///
/// Components:
/// - SDK name and version
/// - Rust version (compile-time)
/// - OS and architecture
///
/// The string is computed once and cached for subsequent calls.
pub fn user_agent() -> &'static str {
    USER_AGENT.get_or_init(|| {
        format!(
            "{}/{} ({}; {}/{})",
            SDK_NAME,
            SDK_VERSION,
            rust_version(),
            os_name(),
            std::env::consts::ARCH,
        )
    })
}

/// Returns a short SDK identifier for contexts with length limits.
///
/// Format: `inferadb-rust/0.1.0`
#[allow(dead_code)]
pub fn short_user_agent() -> String {
    format!("{}/{}", SDK_NAME, SDK_VERSION)
}

/// Returns the Rust version string.
fn rust_version() -> &'static str {
    // This is set at compile time by rustc
    concat!("rust/", env!("CARGO_PKG_RUST_VERSION"))
}

/// Returns a normalized OS name.
fn os_name() -> &'static str {
    match std::env::consts::OS {
        "macos" => "darwin",
        os => os,
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_user_agent_format() {
        let ua = user_agent();

        // Should start with SDK name and version
        assert!(ua.starts_with("inferadb-rust/"));

        // Should contain rust version
        assert!(ua.contains("rust/"));

        // Should contain OS and arch
        assert!(ua.contains(std::env::consts::ARCH));

        // Should be properly formatted with parentheses
        assert!(ua.contains('('));
        assert!(ua.contains(')'));
    }

    #[test]
    fn test_user_agent_cached() {
        // Multiple calls should return the same reference
        let ua1 = user_agent();
        let ua2 = user_agent();
        assert!(std::ptr::eq(ua1, ua2));
    }

    #[test]
    fn test_short_user_agent() {
        let short = short_user_agent();
        assert!(short.starts_with("inferadb-rust/"));
        assert!(!short.contains('('));
    }

    #[test]
    fn test_os_normalization() {
        // Just verify it returns something reasonable
        let os = os_name();
        assert!(!os.is_empty());
    }
}