cc-lb-plugin-api 0.4.0

cc-lb plugin API — public traits and types for built-in plugin authoring.
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

//! Public plugin contract for the `cc-lb` proxy lifecycle.
//!
//! The core proxy owns the wire-level server loop and drives requests through
//! `parse -> authenticate -> route -> shape -> sign -> relay_stream`.
//! This crate defines the stable types and object-safe traits used at those
//! boundaries: authentication plugins identify a [`Principal`], router plugins
//! choose an [`Upstream`] and [`UpstreamDialect`], dialects build a
//! [`ShapedRequest`], signers consume it into a [`SignedRequest`], and the core
//! relays the signed request while emitting [`ObserveEvent`] values to
//! observability hooks.
//!
//! The crate deliberately uses `http`, `bytes`, and `url` types instead of
//! exposing the server's transport implementation. Request body validation,
//! semantic JSON checks, and concrete HTTP client behavior live in downstream
//! crates, not in this API contract.

#![deny(unsafe_code)]
#![warn(missing_docs)]

mod errors;
mod traits;
pub mod types;

pub use errors::{DialectError, ObservabilityError, RouteError, SignerError, UpstreamError};
pub use traits::{
    ApiKeyAwareSignerFactory, FilterError, FilterOutput, FilterPlugin, ObservabilityHook,
    RouterPlugin, Signer, SignerFactory, UpstreamDialect,
};
pub use types::{
    CredentialStrategy, GLOBAL_PRINCIPAL, InternalError, InternalErrorKind, InternalErrorStage,
    ObserveEvent, PerCandidateReason, PluginManifest, PluginSlot, Principal, PrincipalKind,
    PrincipalQuotas, RateLimitKind, RateLimitObservation, RequestContext, RetryDecision,
    RouteDecision, RoutingTrace, ShapedRequest, ShapedRequestBuilder, SignedRequest,
    SigningCapability, SlotKey, SubscriptionQuotaCandidateSnapshot, SubscriptionQuotaDataState,
    TerminalStrategy, Upstream, UpstreamCandidate, UpstreamKind, default_pure, shape_request,
    sign_request,
};

/// Stable registry id for the built-in cache-affinity router filter.
pub const BUILTIN_CACHE_AFFINITY_ID: uuid::Uuid = uuid::Uuid::from_u128(1);

/// Stable registry name for the built-in cache-affinity router filter.
pub const BUILTIN_CACHE_AFFINITY_NAME: &str = "cache-affinity";

/// Stable registry id for the built-in subscription-preference router filter.
pub const BUILTIN_SUBSCRIPTION_PREFERENCE_ID: uuid::Uuid = uuid::Uuid::from_u128(2);

/// Stable registry name for the built-in subscription-preference router filter.
pub const BUILTIN_SUBSCRIPTION_PREFERENCE_NAME: &str = "subscription-preference";

mod private {
    #[derive(Clone, Copy, Debug, Eq, PartialEq)]
    pub(crate) struct Seal;
}