polyoxide_core/
lib.rs

1//! # polyoxide-core
2//!
3//! Core utilities and shared types for Polyoxide Polymarket API clients.
4//!
5//! This crate provides common functionality used across `polyoxide-clob`, `polyoxide-gamma`, `polyoxide-data`, and `polyoxide-relay`:
6//! - Shared error types and error handling
7//! - HTTP client configuration
8//! - Request builder utilities
9//! - HMAC API-credential signing ([`Signer`])
10//! - Per-endpoint rate limiting with retry/backoff ([`RateLimiter`])
11//! - Optional OS keychain credential storage (behind the `keychain` feature)
12//!
13//! ## HTTP Client
14//!
15//! Use [`HttpClientBuilder`] to create configured HTTP clients:
16//!
17//! ```
18//! use polyoxide_core::HttpClientBuilder;
19//!
20//! let client = HttpClientBuilder::new("https://api.example.com")
21//!     .timeout_ms(60_000)
22//!     .build()
23//!     .unwrap();
24//! ```
25//!
26//! ## Error Handling
27//!
28//! Use the [`impl_api_error_conversions`] macro to reduce boilerplate in error types.
29
30// Compile the crate README's `rust` code fences as doctests so broken examples
31// fail CI. `#[cfg(doctest)]` keeps this out of normal builds and `cargo doc`.
32#[cfg(doctest)]
33#[doc = include_str!("../README.md")]
34struct ReadmeDoctests;
35
36#[macro_use]
37pub mod macros;
38
39pub mod auth;
40pub mod client;
41pub mod error;
42pub mod rate_limit;
43pub mod request;
44
45#[cfg(feature = "keychain")]
46pub mod keychain;
47
48/// Maximum number of characters to include in log messages containing response bodies.
49const LOG_BODY_MAX_LEN: usize = 512;
50
51/// Truncate a string for safe inclusion in log output.
52///
53/// Returns the original string if it fits within `LOG_BODY_MAX_LEN`,
54/// otherwise truncates at a UTF-8 boundary and appends `... [truncated]`.
55pub fn truncate_for_log(s: &str) -> std::borrow::Cow<'_, str> {
56    if s.len() <= LOG_BODY_MAX_LEN {
57        std::borrow::Cow::Borrowed(s)
58    } else {
59        let truncated = &s[..s.floor_char_boundary(LOG_BODY_MAX_LEN)];
60        std::borrow::Cow::Owned(format!("{}... [truncated]", truncated))
61    }
62}
63
64pub use auth::{current_timestamp, Base64Format, Signer};
65pub use client::{
66    retry_after_header, HttpClient, HttpClientBuilder, DEFAULT_POOL_SIZE, DEFAULT_TIMEOUT_MS,
67};
68pub use error::ApiError;
69pub use rate_limit::{RateLimiter, RetryConfig};
70pub use request::{QueryBuilder, Request, RequestError};
71
72#[cfg(feature = "keychain")]
73pub use keychain::KeychainError;
74
75#[cfg(test)]
76mod tests {
77    use super::*;
78
79    #[test]
80    fn test_truncate_for_log_short_string_unchanged() {
81        let short = "hello world";
82        let result = truncate_for_log(short);
83        assert_eq!(result.as_ref(), short);
84    }
85
86    #[test]
87    fn test_truncate_for_log_exact_limit_unchanged() {
88        let exact = "a".repeat(LOG_BODY_MAX_LEN);
89        let result = truncate_for_log(&exact);
90        assert_eq!(result.as_ref(), exact.as_str());
91    }
92
93    #[test]
94    fn test_truncate_for_log_over_limit_truncated() {
95        let long = "x".repeat(LOG_BODY_MAX_LEN + 100);
96        let result = truncate_for_log(&long);
97        assert!(result.ends_with("... [truncated]"));
98        assert!(result.len() < long.len());
99    }
100
101    #[test]
102    fn test_truncate_for_log_multibyte_char_boundary() {
103        // Create a string where the 512th byte falls inside a multi-byte char
104        let mut s = "a".repeat(LOG_BODY_MAX_LEN - 1);
105        s.push('\u{1F600}'); // 4-byte emoji at position 511-514
106        s.push_str("overflow");
107        let result = truncate_for_log(&s);
108        assert!(result.ends_with("... [truncated]"));
109        // Should not panic or produce invalid UTF-8
110        assert!(result.is_char_boundary(0));
111    }
112}
polyoxide_core/lib.rs

polyoxide_core/
lib.rs
