Skip to content

fix(config): mark config structs non_exhaustive + center donation section #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
polaz merged 2 commits into from
Jun 20, 2026
Merged

fix(config): mark config structs non_exhaustive + center donation section #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
302fcb7
fix(config): mark config structs non_exhaustive
polaz Jun 20, 2026
b88ac13
docs: center the Support the Project section
polaz Jun 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,11 +210,11 @@ Client (HTTP/JSON)
Upstream Service
```

## Support the Project

<div align="center">

![USDT TRC-20 Donation QR Code](./assets/usdt-qr.svg)
## Support the Project

<img src="./assets/usdt-qr.svg" alt="USDT TRC-20 Donation QR Code" width="200">

USDT (TRC-20): `TFDsezHa1cBkoeZT5q2T49Wp66K8t2DmdA`

Expand Down
21 changes: 21 additions & 0 deletions src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ use std::path::PathBuf;

/// Top-level proxy configuration (loaded from YAML).
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ProxyConfig {
/// Upstream gRPC service(s).
pub upstream: UpstreamConfig,
Expand Down Expand Up @@ -81,13 +82,15 @@ fn default_forwarded_headers() -> Vec<String> {

/// Upstream gRPC service configuration.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct UpstreamConfig {
/// gRPC upstream address (e.g., "http://localhost:4180").
pub default: String,
}

/// Descriptor loading source.
#[derive(Debug, Clone)]
#[non_exhaustive]
pub enum DescriptorSource {
/// Pre-compiled descriptor file.
File { file: PathBuf },
Expand Down Expand Up @@ -128,6 +131,7 @@ where

/// Listen address configuration.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ListenConfig {
/// HTTP listen address (default: "0.0.0.0:8080").
#[serde(default = "default_http_listen")]
Expand All @@ -148,6 +152,7 @@ impl Default for ListenConfig {

/// Service identity.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ServiceConfig {
/// Service name (appears in /health response and metrics namespace).
#[serde(default = "default_service_name")]
Expand All @@ -168,13 +173,15 @@ impl Default for ServiceConfig {

/// Path alias (rewrite before routing).
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct AliasConfig {
pub from: String,
pub to: String,
}

/// OpenAPI generation config.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct OpenApiConfig {
#[serde(default = "default_true")]
pub enabled: bool,
Expand Down Expand Up @@ -204,6 +211,7 @@ fn default_true() -> bool {

/// Auth configuration.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct AuthConfig {
/// Auth mode: "none", "jwt", "api_key".
#[serde(default = "default_auth_mode")]
Expand All @@ -228,6 +236,7 @@ fn default_auth_mode() -> String {

/// JWT validation config.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct JwtConfig {
/// JWKS URI for key discovery.
#[serde(default)]
Expand Down Expand Up @@ -256,6 +265,7 @@ fn default_roles_claim() -> String {

/// Forward auth config.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ForwardAuthConfig {
#[serde(default)]
pub enabled: bool,
Expand All @@ -278,6 +288,7 @@ fn default_forward_auth_path() -> String {

/// Route policy entry.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct RoutePolicyConfig {
pub path: String,
#[serde(default = "default_methods_all")]
Expand All @@ -296,6 +307,7 @@ fn default_methods_all() -> Vec<String> {
/// (`envoy.service.auth.v3.Authorization/Check`). Interops with OPA and any
/// ext_authz server.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct AuthzConfig {
/// Enable external authorization for proxied API requests.
#[serde(default)]
Expand All @@ -319,6 +331,7 @@ fn default_authz_timeout_ms() -> u64 {

/// Shield (rate limiting) configuration.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ShieldConfig {
#[serde(default)]
pub enabled: bool,
Expand Down Expand Up @@ -352,6 +365,7 @@ fn default_window_secs() -> u64 {

/// Endpoint classification for rate limiting.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct EndpointClassConfig {
/// Glob pattern (e.g., "/v1/auth/**").
pub pattern: String,
Expand All @@ -363,6 +377,7 @@ pub struct EndpointClassConfig {

/// Per-identifier rate limiting config.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct IdentifierEndpointConfig {
pub path: String,
pub body_field: String,
Expand All @@ -371,6 +386,7 @@ pub struct IdentifierEndpointConfig {

/// OIDC discovery config.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct OidcDiscoveryConfig {
#[serde(default)]
pub enabled: bool,
Expand All @@ -389,6 +405,7 @@ pub struct OidcDiscoveryConfig {

/// Signing key config for JWKS endpoint.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SigningKeyConfig {
#[serde(default = "default_algorithm")]
pub algorithm: String,
Expand All @@ -401,6 +418,7 @@ fn default_algorithm() -> String {

/// Maintenance mode config.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct MaintenanceConfig {
#[serde(default)]
pub enabled: bool,
Expand Down Expand Up @@ -436,6 +454,7 @@ impl Default for MaintenanceConfig {

/// CORS configuration.
#[derive(Debug, Clone, Default, Deserialize)]
#[non_exhaustive]
pub struct CorsConfig {
/// Allowed origins. Empty = permissive (dev mode).
#[serde(default)]
Expand All @@ -444,6 +463,7 @@ pub struct CorsConfig {

/// Logging configuration.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct LoggingConfig {
#[serde(default = "default_log_level")]
pub level: String,
Expand All @@ -469,6 +489,7 @@ impl Default for LoggingConfig {

/// Metrics endpoint classification.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct MetricsClassConfig {
/// Glob pattern for path matching.
pub pattern: String,
Expand Down