proxima-lib 0.1.0

A sans-IO core where everything is a Pipe — one async In -> Result<Out, Err> trait worn four ways (transform, source, sink, observe), composed into proxies, gateways, caches, codecs and telemetry pipelines. Config-driven, runtime-agnostic: the same pipe runs on the from-scratch Prime per-core runtime, on tokio, or on no_std bare metal.
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

//! Middleware [`Pipe`](crate::pipe::Pipe) implementations — each wraps an
//! inner `Pipe` and transforms request, response, or call decision.
//! Top-down reading order = request execution order; the response
//! unwinds in reverse.
//!
//! ```no_run
//! use proxima::{App, BearerAuth, Composable, HttpUpstream};
//! use proxima::settings::RateLimit;
//! use std::time::Duration;
//!
//! # async fn doc() -> Result<(), proxima::ProximaError> {
//! let mut app = App::new()?;
//! app.pipe(
//!     "api",
//!     BearerAuth::allow_tokens(["t-1"])            // auth fires first
//!         .then(RateLimit::token_bucket(100, 50))  // then rate limit
//!         .then(HttpUpstream::builder()            // leaf upstream
//!             .url("https://backend.internal")
//!             .timeout(Duration::from_secs(5))
//!             .build()),
//! ).await?;
//! # Ok(())
//! # }
//! ```
//!
//! The composable settings surface is `BearerAuth` and `RateLimit` today; the
//! rest of the middleware set is reached through a spec rather than `.then()`
//! (see `settings::middleware`'s module doc).
//!
//! Order is not commutative — `Auth` after `Retry` would retry
//! unauthenticated requests; `Retry` after `Auth` retries only
//! authenticated work. Pick deliberately.
//!
//! Each module below is a single middleware. Cross-cutting
//! composition primitives (`Tee`,
//! [`Diff`], [`Isolate`],
//! [`Causal`](crate::Causal), [`SwappablePipe`](crate::SwappablePipe),
//! [`WriteBack`]) live alongside as their own
//! top-level modules; see the [`mod@crate::pipe`] module rustdoc for the
//! full menu (core primitives, recording-as-Pipe, serving).

pub use proxima_patterns::middleware::auth;
pub use proxima_patterns::middleware::client_auth;
pub use proxima_patterns::middleware::write_back;
pub use proxima_primitives::pipe::diff;
pub use proxima_primitives::pipe::isolate;
pub use proxima_primitives::pipe::rate_limit;
pub use proxima_primitives::pipe::retry;
pub use proxima_primitives::pipe::transform;
pub use proxima_primitives::pipe::validate;

pub use proxima_patterns::middleware::auth::{Auth, AuthFactory};
pub use proxima_patterns::middleware::client_auth::{ClientAuthFactory, ClientAuthPipe};
pub use proxima_patterns::middleware::write_back::{WriteBack, WriteBackTarget};
pub use proxima_primitives::pipe::diff::{Diff, diff_handle};
pub use proxima_primitives::pipe::isolate::{Isolate, IsolateFactory};
pub use proxima_primitives::pipe::rate_limit::{
    ExceededAction, KeyExtractor, KeyOf, RateLimit, RateLimitCaps, RateLimitFactory,
    TokenBucketConfig,
};
pub use proxima_primitives::pipe::retry::{Retry, RetryBudget, RetryFactory, RetryPredicate};
pub use proxima_primitives::pipe::transform::{RequestOp, ResponseOp, Transform, TransformFactory};
pub use proxima_primitives::pipe::validate::{Validate, ValidateFactory};