Struct ProxyConfig 

pub struct ProxyConfig {

    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>,
    pub streaming: StreamingConfig,
}

Top-level proxy configuration (loaded from YAML).

This and the wiring structs below (UpstreamConfig, ListenConfig, ServiceConfig, DescriptorSource) are intentionally NOT #[non_exhaustive]: embedding consumers build them programmatically with runtime values. The leaf auth/shield/oidc config structs are #[non_exhaustive] instead, since those are deserialized, not hand-built.

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.

streaming: StreamingConfig

Server-streaming response behavior.

Implementations

impl ProxyConfig

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

Load configuration from a YAML file.

pub fn from_yaml_str(yaml: &str) -> Result<Self>

Parse configuration from a YAML string.

Useful for embedding the proxy: load a baked-in config (e.g. via include_str!) without touching the filesystem.

pub fn validate(&self) -> Result<()>

Validate cross-field constraints that the type system can’t express.

Called automatically by from_yaml_str; call it directly when building a ProxyConfig programmatically so the same invariants are enforced on the embedded path.

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.

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

Performs copy-assignment from source.

impl Debug for ProxyConfig

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

Formats the value using the given formatter.

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.