Skip to main content

ServerConfig

Struct ServerConfig 

Source
pub struct ServerConfig {
Show 15 fields pub cors_allow_all: bool, pub cors_allow_origins: String, pub cors_allow_credentials: String, pub cors_allow_methods: String, pub cors_allow_headers: String, pub cors_expose_headers: String, pub cors_max_age: String, pub csp: String, pub security_headers: bool, pub nanos_headers: bool, pub client_hints: bool, pub static_cache_control: String, pub directory_listing: bool, pub log_format: String, pub request_allocation_size: i64,
}
Expand description

All runtime-configurable settings for one server instance.

Fields map 1-to-1 to RWS_CONFIG_* environment variable names documented in Config. Default values match the environment-variable defaults.

Construct via ServerConfig::from_env() at startup or ServerConfig::default() in tests.

Fields§

§cors_allow_all: bool

RWS_CONFIG_CORS_ALLOW_ALL — when true, all cross-origin requests are reflected back as allowed (echo the Origin header). Overrides all other CORS fields. Default: true.

§cors_allow_origins: String

RWS_CONFIG_CORS_ALLOW_ORIGINS — comma-separated list of allowed origins when cors_allow_all is false. Default: "" (none).

§cors_allow_credentials: String

RWS_CONFIG_CORS_ALLOW_CREDENTIALS — value for the Access-Control-Allow-Credentials response header. Default: "".

§cors_allow_methods: String

RWS_CONFIG_CORS_ALLOW_METHODS — value for Access-Control-Allow-Methods. Default: "".

§cors_allow_headers: String

RWS_CONFIG_CORS_ALLOW_HEADERS — value for Access-Control-Allow-Headers. Default: "".

§cors_expose_headers: String

RWS_CONFIG_CORS_EXPOSE_HEADERS — value for Access-Control-Expose-Headers. Default: "".

§cors_max_age: String

RWS_CONFIG_CORS_MAX_AGE — value for Access-Control-Max-Age. Default: "86400".

§csp: String

RWS_CONFIG_CSP — Content-Security-Policy header value. An empty string suppresses the header. Unset: default-src 'self' when security_headers is on, otherwise no header (18.0.0; was always default-src 'self').

§security_headers: bool

RWS_CONFIG_SECURITY_HEADERS — send X-Frame-Options: SAMEORIGIN, Referrer-Policy and Permissions-Policy on every response (and the default CSP, unless RWS_CONFIG_CSP is set). Off by default (18.0.0; was always on): nginx sends none of them, and over HTTP/2 every header costs HPACK work. X-Content-Type-Options: nosniff is always sent.

§nanos_headers: bool

RWS_CONFIG_NANOS_HEADERS — send Date-Unix-Epoch-Nanos and, for static files, Last-Modified-Unix-Epoch-Nanos. Off by default (18.0.0; was always on): they change on every response, so HTTP/2 can’t index them, and Date/Last-Modified carry the same information to the second.

§client_hints: bool

RWS_CONFIG_CLIENT_HINTS — send Accept-CH, Critical-CH and the client hints in Vary on every response. Off by default (18.0.0; was always on): ~700 bytes per response, and Critical-CH makes Chromium retry a request that came without the hints.

§static_cache_control: String

RWS_CONFIG_STATIC_CACHE_CONTROL — Cache-Control for static files (other responses keep no-store, …). Default "no-cache" (18.0.0; was no-store, …): browsers keep the file and revalidate it with If-None-Match / If-Modified-Since (a 304). An empty value keeps the no-store default for static files too.

§directory_listing: bool

RWS_CONFIG_DIRECTORY_LISTING — list a directory that has no index.html. Default true; false answers 404 instead (18.8.4).

§log_format: String

RWS_CONFIG_LOG_FORMAT — "json" or "combined". Default: "json".

§request_allocation_size: i64

RWS_CONFIG_REQUEST_ALLOCATION_SIZE_IN_BYTES — bytes allocated for incoming request parsing. Default: 10000.

Implementations§

Source§

impl ServerConfig

Source

pub fn from_env() -> Self

Build a ServerConfig by reading all RWS_CONFIG_* environment variables. Missing variables fall back to their default values.

Each call reads every variable — the environment lock is taken once per variable — so per-request code uses ServerConfig::current.

Source

pub fn current() -> Arc<ServerConfig> ⓘ

The configuration from the environment, read once and shared: an atomic load and an Arc clone per call instead of ten getenvs. Rebuilt after invalidate — which config_reload::reload() (SIGHUP, POST /admin/config/reload) and every config writer in the crate call, so hot reload still takes effect on the next request.

Trait Implementations§

Source§

impl Clone for ServerConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ServerConfig

Source§

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

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

impl Default for ServerConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for ServerConfig

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ServerConfig

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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