Skip to main content

ProxyConfig

structured_proxy::config

Struct ProxyConfig

pub struct ProxyConfig {Show 14 fields
    pub upstream: UpstreamConfig,
    pub descriptors: Vec<DescriptorSource>,
    pub listen: ListenConfig,
    pub service: ServiceConfig,
    pub aliases: Vec<AliasConfig>,
    pub openapi: Option<OpenApiConfig>,
    pub auth: Option<AuthConfig>,
    pub shield: Option<ShieldConfig>,
    pub oidc_discovery: Option<OidcDiscoveryConfig>,
    pub maintenance: MaintenanceConfig,
    pub cors: CorsConfig,
    pub logging: LoggingConfig,
    pub metrics_classes: Vec<MetricsClassConfig>,
    pub forwarded_headers: Vec<String>,
}

Expand description

Top-level proxy configuration (loaded from YAML).

Fields§

§upstream: UpstreamConfig

Upstream gRPC service(s).

§descriptors: Vec<DescriptorSource>

Proto descriptor sources.

§listen: ListenConfig

Listen addresses.

§service: ServiceConfig

Service identity (for health endpoint, metrics namespace).

§aliases: Vec<AliasConfig>

Path aliases (e.g., /oauth2/* → /v1/oauth2/*).

§openapi: Option<OpenApiConfig>

OpenAPI generation.

§auth: Option<AuthConfig>

Auth configuration (JWT, forward auth, AuthZ).

§shield: Option<ShieldConfig>

Rate limiting (Shield).

§oidc_discovery: Option<OidcDiscoveryConfig>

OIDC discovery (optional — for IdP proxies).

§maintenance: MaintenanceConfig

Maintenance mode.

§cors: CorsConfig

CORS configuration.

§logging: LoggingConfig

Logging.

§metrics_classes: Vec<MetricsClassConfig>

Metrics endpoint classification (path patterns → class labels).

§forwarded_headers: Vec<String>

Headers to forward from HTTP to gRPC metadata.

Implementations§

impl ProxyConfig

pub fn from_file(path: &Path) -> Result<Self>

Load configuration from a YAML file.

pub fn parse_rate(rate: &str) -> Option<u32>

Parse rate string like “20/min” → requests per window.

Trait Implementations§

impl Clone for ProxyConfig

fn clone(&self) -> ProxyConfig

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

impl Debug for ProxyConfig

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ProxyConfig

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

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

impl Freeze for ProxyConfig

impl RefUnwindSafe for ProxyConfig

impl Send for ProxyConfig

impl Sync for ProxyConfig

impl Unpin for ProxyConfig

impl UnsafeUnpin for ProxyConfig

impl UnwindSafe for ProxyConfig

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

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

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

fn from_ref(input: &T) -> T

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

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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