Skip to main content

Plane

Enum Plane 

Source
pub enum Plane {
    Both,
    Data,
    Credential,
}
Expand description

Build the data-plane router (/v1/*), with EdgeState baked in.

This is the reusable half: the self-host binary adds its own health routes around it (see crate::run); the hosted gateway merges it under its auth + metering middleware alongside its control-plane routes. It deliberately does NOT register /health/*, so a host app can own health without colliding.

§What this router does NOT include

No transport-level protection is attached here — not the request-body cap, the request timeout, the credential-header redaction, or tracing. An embedder must apply them, and crate::harden does exactly that.

The body cap is the one most easily missed: crate::EdgeConfig exposes max_body_bytes as a validated knob, which makes it reasonable to assume the router already honours it. It does not. Which planes a given process serves.

One binary, deployed twice. The data plane carries every tenant’s memory traffic; the credential plane is the only place a plaintext provider key exists in memory, and it sits on the LLM path with a completely different latency profile.

Running both in one process is supported, and is the default — standing up two deployments just to try BYOK would be absurd. Production should split them: it keeps every tenant’s keys out of the busiest process and lets the two scale on their own shapes.

Variants§

§

Both

Memory verbs plus credentials and the broker. The default.

§

Data

Memory verbs only. No key material is reachable in this process.

§

Credential

BYOK credential management and the broker only.

Implementations§

Source§

impl Plane

Source

pub fn from_name(name: &str) -> Result<Self, String>

Parse a PLANE_ENV value.

§Errors

Names the accepted set. An unrecognised plane is a hard error rather than a silent fallback to Both: quietly serving credentials from a process an operator meant to be data-only is the exact mistake this flag exists to prevent.

Source

pub fn from_env() -> Result<Self, String>

Read the plane from the environment.

§Errors

As Self::from_name.

Source

pub const fn serves_data(self) -> bool

Whether this plane serves the memory verbs.

Source

pub const fn serves_credentials(self) -> bool

Whether this plane serves credentials and the broker.

Trait Implementations§

Source§

impl Clone for Plane

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for Plane

Source§

impl Debug for Plane

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Plane

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for Plane

Source§

impl PartialEq for Plane

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Plane

Auto Trait Implementations§

§

impl Freeze for Plane

§

impl RefUnwindSafe for Plane

§

impl Send for Plane

§

impl Sync for Plane

§

impl Unpin for Plane

§

impl UnsafeUnpin for Plane

§

impl UnwindSafe for Plane

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more