Skip to main content

StackConfig

Struct StackConfig 

Source
#[non_exhaustive]
pub struct StackConfig { pub timeout: Option<Duration>, pub max_request_body_wire_bytes: Option<usize>, pub max_request_body_decoded_bytes: Option<usize>, pub load_shed: bool, pub compression: Option<CompressionOptions>, pub decompression: bool, }
Expand description

Tower stack configuration shared by [build_stack] and [build_client_stack].

Each field is consumed by a dedicated apply_* factory in this module (see [build_stack]’s body). Factories are no-ops when their field is None/false, so toggling a field off produces a service whose runtime shape is identical to the layer never having been built.

Composition uses the axum-style boxed-per-layer pattern: every apply_* takes a [ServeService] and returns a [ServeService], performing its own boxed_clone(). This re-erases the inner Service::Future after each layer, so layer addition is decoupled from the type-soup of Either<L::Service, S> and impl Layer<…> return-position bound erasure (see Slice B (#184) carry-forward in Slice C (#185)).

Slice D (#186): made public so the pure-Rust crate::http::client::fetch_request can take &StackConfig directly. #[non_exhaustive] so adapters constructing literal StackConfig values (StackConfig { timeout, decompression, ..default() }) opt in explicitly and future fields don’t break them.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§timeout: Option<Duration>

Per-request timeout. None ⇒ no TimeoutLayer is applied.

§max_request_body_wire_bytes: Option<usize>

Maximum wire request body size before the server rejects with 413.

This limit is applied before decompression, i.e. it counts compressed bytes as they arrive from the QUIC stream. It is an effective guard against network-level DoS (high-bandwidth senders), but it does not protect against a compression bomb (a small compressed body that decompresses to many GB). Use Self::max_request_body_decoded_bytes for that.

§max_request_body_decoded_bytes: Option<usize>

Maximum decoded request body size before the server rejects with 413.

This limit is applied after decompression. It is the primary guard against compression bombs: a zstd payload that is tiny on the wire but expands to GB in memory is rejected once the decoded byte count crosses this threshold. The default at the super::serve entry point is 16 MiB (matching the documented behaviour that the old single-limit field max_request_body_bytes had always promised but never delivered).

§load_shed: bool

true ⇒ wrap with LoadShedLayer so saturated capacity returns 503 immediately rather than blocking the caller.

§compression: Option<CompressionOptions>

Operator’s compression configuration. None disables response compression on the server side; ignored by [build_client_stack] (clients do not yet compress request bodies).

§decompression: bool

true ⇒ apply RequestDecompressionLayer (server) / DecompressionLayer (client). Defaults to true — every server today accepts compressed requests, every client accepts compressed responses.

Implementations§

Source§

impl StackConfig

Source

pub fn with_timeout(self, timeout: Option<Duration>) -> Self

Set Self::timeout using the builder pattern.

Convenience constructor for external callers — #[non_exhaustive] blocks struct-literal construction outside this crate, so use StackConfig::default().with_timeout(...).

Source

pub fn with_decompression(self, decompression: bool) -> Self

Set Self::decompression using the builder pattern.

Trait Implementations§

Source§

impl Clone for StackConfig

Source§

fn clone(&self) -> StackConfig

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 StackConfig

Source§

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

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

impl Default for StackConfig

Source§

fn default() -> Self

Returns the “default value” for a type. 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<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<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