Skip to main content

tokentriage/
lib.rs

1//! # tokentriage — placeholder crate
2//!
3//! **This crate contains no working code.** It reserves the `tokentriage` name
4//! on crates.io for the future Rust instrumentation binding of the
5//! [TokenTriage](https://github.com/tokentriage/tokentriage) proxy, which has
6//! not been written yet.
7//!
8//! Nothing here contacts a proxy, renders an `x-tt-*` header, or parses a
9//! receipt. Do not build against this version — it exposes no API beyond the
10//! two constants below, and the real surface will not be source-compatible
11//! with anything you infer from it.
12//!
13//! The implemented bindings today are `tokentriage` on PyPI (Python) and
14//! `tokentriage` on npm (TypeScript).
15
16#![forbid(unsafe_code)]
17#![deny(missing_docs)]
18
19/// Always `true` for a placeholder release.
20///
21/// The first real release will remove this constant entirely, so a build that
22/// depends on it will fail loudly rather than silently keep working.
23pub const IS_PLACEHOLDER: bool = true;
24
25/// Human-readable explanation of why this crate does nothing.
26pub const NOTICE: &str = "tokentriage: placeholder crate — the Rust SDK is not implemented yet. \
27                          Use the Python (PyPI) or TypeScript (npm) binding.";
28
29#[cfg(test)]
30mod tests {
31    use super::*;
32
33    #[test]
34    fn placeholder_is_marked_as_such() {
35        assert!(IS_PLACEHOLDER);
36        assert!(NOTICE.contains("placeholder"));
37    }
38}