Skip to main content

Crate everscribe

Crate everscribe 

Source
Expand description

Everscribe Rust SDK.

Rust SDK for the Everscribe audit-log API. Two coordinated surfaces:

  • recorder - append-only event ingest.
  • minter - short-lived embed tokens for frontend audit views.

Bind credentials once with new (or new_from_env) and create per-surface subclients from the returned Client:

let es = everscribe::new("proj_...", "es_live_...")?;
let rec = es.new_recorder(Default::default());
rec.record(everscribe::Event::new("user.login")).await.ok();

Customers who only need one surface can call its constructor directly - recorder::new and minter::Client::new both work and skip the client step. Optional framework adapters live in axum (the axum feature), actix (the actix feature), and tonic (the tonic feature).

Re-exports§

pub use event::Event;

Modules§

actix
actix-web adapter (behind the actix cargo feature).
axum
axum / tower middleware adapter (behind the axum cargo feature).
event
Event domain: the on-the-wire event model, redaction, the request-scoped record lifecycle, and request-context helpers.
minter
Minter: short-lived embed tokens for frontend audit-log views.
recorder
Recorder: append-only event ingest over HTTP with async buffering.
tonic
tonic / tower gRPC adapter (behind the tonic cargo feature).

Structs§

Client
A credential-bearing handle to an Everscribe project. Holds no network state itself; the subclient constructors build per-surface clients. Reuse a single client for the lifetime of the process.

Enums§

ConfigError
Errors constructing a Client.

Constants§

EVERSCRIBE_API_KEY
Environment variable read by new_from_env for the API key.
EVERSCRIBE_PROJECT_ID
Environment variable read by new_from_env for the project ID.

Functions§

new
Construct a Client. See Client::new.
new_from_env
Construct a Client from environment variables. See Client::from_env.