Skip to main content

RouteConfig

Struct RouteConfig 

Source
pub struct RouteConfig {
    pub prefix: String,
    pub upstream: String,
    pub credential_key: Option<String>,
    pub inject_mode: InjectMode,
    pub inject_header: String,
    pub credential_format: String,
    pub path_pattern: Option<String>,
    pub path_replacement: Option<String>,
    pub query_param_name: Option<String>,
    pub env_var: Option<String>,
    pub endpoint_rules: Vec<EndpointRule>,
    pub tls_ca: Option<String>,
}
Expand description

Configuration for a reverse proxy credential route.

Fields§

§prefix: String

Path prefix for routing (e.g., “/openai”)

§upstream: String

Upstream URL to forward to (e.g., “https://api.openai.com”)

§credential_key: Option<String>

Keystore account name to load the credential from. If None, no credential is injected.

§inject_mode: InjectMode

Injection mode (default: “header”)

§inject_header: String

HTTP header name for the credential (default: “Authorization”) Only used when inject_mode is “header”.

§credential_format: String

Format string for the credential value. {} is replaced with the secret. Default: “Bearer {}” Only used when inject_mode is “header”.

§path_pattern: Option<String>

Pattern to match in incoming URL path. Use {} as placeholder for phantom token. Example: “/bot{}/” matches “/bot/getMe” Only used when inject_mode is “url_path”.

§path_replacement: Option<String>

Pattern for outgoing URL path. Use {} as placeholder for real credential. Defaults to same as path_pattern if not specified. Only used when inject_mode is “url_path”.

§query_param_name: Option<String>

Name of the query parameter to add/replace with the credential. Only used when inject_mode is “query_param”.

§env_var: Option<String>

Explicit environment variable name for the phantom token (e.g., “OPENAI_API_KEY”).

When set, this is used as the SDK API key env var name instead of deriving it from credential_key.to_uppercase(). Required when credential_key is a URI manager reference (e.g., op://, apple-password://) which would otherwise produce a nonsensical env var name.

§endpoint_rules: Vec<EndpointRule>

Optional L7 endpoint rules for method+path filtering.

When non-empty, only requests matching at least one rule are allowed (default-deny). When empty, all method+path combinations are permitted (backward compatible).

§tls_ca: Option<String>

Optional path to a PEM-encoded CA certificate file for upstream TLS.

When set, the proxy trusts this CA in addition to the system roots when connecting to the upstream for this route. This is required for upstreams that use self-signed or private CA certificates (e.g., Kubernetes API servers).

Trait Implementations§

Source§

impl Clone for RouteConfig

Source§

fn clone(&self) -> RouteConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RouteConfig

Source§

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

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

impl<'de> Deserialize<'de> for RouteConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for RouteConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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<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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,