xdk-rs 0.1.3

Async Rust client for the X (Twitter) API: OAuth1, OAuth2 PKCE, bearer tokens, media upload, streaming. xdk is X's SDK name; this is an independent project, not affiliated with X Corp.
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

#![doc = include_str!("../README.md")]
#![deny(missing_docs)]
// The three `REDIRECT_URI` unit tests need edition 2024's `unsafe { set_var }`
// (allowlisted in the env-mutation guard), so the ban covers every build an
// embedder compiles and leaves the test build alone.
#![cfg_attr(not(test), forbid(unsafe_code))]
#![warn(missing_debug_implementations)]
// docs.rs passes `--cfg docsrs` on nightly, where `doc_cfg` renders a feature
// badge on every gated item; stable never sees the feature gate.
#![cfg_attr(docsrs, feature(doc_cfg))]

// reqwest compiles without a TLS backend and only fails at the first https
// request, with an error that never mentions TLS; failing the build names
// the fix instead.
#[cfg(not(any(feature = "rustls", feature = "native-tls")))]
compile_error!(
    "xdk-rs needs a TLS backend: enable the `rustls` feature (on by default) or `native-tls`, \
     for example `xdk-rs = { version = \"0.1\", default-features = false, features = [\"native-tls\"] }`"
);

pub mod api;
pub mod auth;
pub mod config;
pub mod error;
pub mod store;
#[cfg(feature = "testing")]
#[cfg_attr(docsrs, doc(cfg(feature = "testing")))]
pub mod testing;

pub use error::{Error, Result};

/// Fails the build when `$t` stops being shareable across tasks and threads.
///
/// Invoked beside each type it guards, so the failure surfaces there rather
/// than at a distant call site. Exported so the `xr` crate guards its own
/// types with the same assertion; it is not embedder API.
#[doc(hidden)]
#[macro_export]
macro_rules! assert_send_sync {
    ($t:ty) => {
        const _: fn() = || {
            fn assert<T: Send + Sync>() {}
            assert::<$t>();
        };
    };
}

// ── Compile-time build and provenance metadata ──────────────────────────
//
// API spec consts are read from a checked-in sidecar at
// `vendor/spec-metadata.json` rather than derived from git context, so
// the values always describe the actual bytes that ship — uncommitted
// local refreshes, crates.io tarball installs, and downstream git-pin
// consumers all see identity that matches the bundled spec.
//
// `CRATE_GIT_SHA` is the only field that depends on git context; it
// resolves to `None` on crates.io tarball builds where `.git` is not
// present and `Some` on local development and CI builds.

/// Version of this crate, from `[package].version` in `Cargo.toml`.
pub const CRATE_VERSION: &str = env!("CARGO_PKG_VERSION");

/// Git commit SHA the crate was built from. `None` when the build had
/// no git context (e.g., `cargo install` from a crates.io tarball,
/// where `.git` is not present).
pub const CRATE_GIT_SHA: Option<&'static str> = option_env!("XDK_CRATE_GIT_SHA");

/// X API OpenAPI spec version (`info.version` field) of the vendored
/// `vendor/x-api-openapi.json` at build time, read from the
/// `vendor/spec-metadata.json` sidecar. X bumps spec content without
/// bumping this field; pair with [`API_SPEC_SHA256`] when drift detection
/// matters.
pub const API_SPEC_VERSION: &str = env!("XDK_API_SPEC_VERSION");

/// SHA-256 of `vendor/x-api-openapi.json` at the time of its most recent
/// vendoring, read from `vendor/spec-metadata.json`. Drift-sensitive
/// identifier — changes every time X changes spec content, regardless of
/// [`API_SPEC_VERSION`].
pub const API_SPEC_SHA256: &str = env!("XDK_API_SPEC_SHA256");

/// Date (UTC, `YYYY-MM-DD`) the vendored OpenAPI spec was last refreshed
/// by `scripts/refresh-x-openapi.sh`, read from `vendor/spec-metadata.json`.
pub const API_SPEC_DATE: &str = env!("XDK_API_SPEC_DATE");