Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub admin: AdminConfig,
    pub body_limits: BodyLimitsConfig,
    pub clusters: Vec<Cluster>,
    pub filter_chains: Vec<FilterChainConfig>,
    pub insecure_options: InsecureOptions,
    pub listeners: Vec<Listener>,
    pub runtime: RuntimeConfig,
    pub shutdown_timeout_secs: u64,
}
Expand description

Top-level proxy configuration.

use praxis_core::config::Config;

let config = Config::from_yaml(
    r#"
listeners:
  - name: web
    address: "127.0.0.1:8080"
    filter_chains: [main]
filter_chains:
  - name: main
    filters:
      - filter: static_response
        status: 200
"#,
)
.unwrap();
assert_eq!(config.listeners[0].address, "127.0.0.1:8080");

Fields§

§admin: AdminConfig

Admin endpoint settings (address and verbosity).

§body_limits: BodyLimitsConfig

Global hard ceilings on request and response body size.

§clusters: Vec<Cluster>

Cluster definitions referenced by filters.

§filter_chains: Vec<FilterChainConfig>

Named filter chains.

§insecure_options: InsecureOptions

Consolidated security overrides. All default to false.

§listeners: Vec<Listener>

Proxy listeners to bind.

§runtime: RuntimeConfig

Runtime configuration knobs.

§shutdown_timeout_secs: u64

Drain time for graceful shutdown.

Implementations§

Source§

impl Config

Source

pub fn validate(&mut self) -> Result<(), ProxyError>

Validate config constraints.

§Errors

Returns ProxyError::Config if any constraint is violated.

use praxis_core::config::Config;

let err = Config::from_yaml("listeners: []\n").unwrap_err();
assert!(err.to_string().contains("at least one listener"));
Source§

impl Config

Source

pub fn from_yaml(s: &str) -> Result<Self, ProxyError>

Parse config from a YAML string.

§Errors

Returns ProxyError::Config if the YAML is invalid, oversized, or fails validation.

§Security: Error Messages

Parse errors from serde_yaml may include context snippets from the input YAML. This is acceptable for server-side operator tooling but callers should avoid exposing these errors to untrusted end users.

use praxis_core::config::Config;

let cfg = Config::from_yaml(
    r#"
listeners:
  - name: web
    address: "127.0.0.1:8080"
    filter_chains: [main]
filter_chains:
  - name: main
    filters:
      - filter: static_response
        status: 200
"#,
)
.unwrap();
assert_eq!(cfg.listeners[0].address, "127.0.0.1:8080");
Source

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

Load and validate config from a YAML file.

§Errors

Returns ProxyError::Config if the file cannot be read or contains invalid config.

use std::path::Path;

use praxis_core::config::Config;

let cfg = Config::from_file(Path::new("praxis.yaml")).unwrap();
println!("listeners: {}", cfg.listeners.len());
Source

pub fn load( explicit_path: Option<&str>, fallback_yaml: &str, ) -> Result<Self, ProxyError>

Resolve configuration file. Fall back to praxis.yaml in the working directory, then fallback_yaml.

§Errors

Returns ProxyError::Config if the resolved config source cannot be loaded or is invalid.

use praxis_core::config::Config;

let yaml = "listeners: [{name: w, address: '0:80'}]";
let cfg = Config::load(None, yaml).unwrap();

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

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 Config

Source§

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

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

impl<'de> Deserialize<'de> for Config

Source§

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§

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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>,