Struct MemoryLimitLayer

pub struct MemoryLimitLayer<M>
where
    M: AvailableMemory,
{ /* private fields */ }

Enforces a limit on the underlying service when a memory Threshold is met.

A common use case is to load shed (reject requests), once the threshold is met. For doing so you must add tower’s load_shed layer. Otherwise the service enqueues requests until the memory is available again.

Implementations

impl<M> MemoryLimitLayer<M>

where M: AvailableMemory,

pub fn available_memory(&self) -> Result<usize, BoxError>

Get the available memory. Can be used to validate the inner memory stat provder before adding the layer.

pub const fn new(threshold: Threshold, provider: M) -> Self

Create a new concurrency limit layer with a default MemoryLimitLayer::retry_interval of 50ms.

pub fn with_retry_interval(self, retry_interval: Duration) -> Self

Set a custom MemoryLimitLayer::retry_interval which determines when the next memory check is performed, if the threshold is exceeded.

Trait Implementations

impl<M> Clone for MemoryLimitLayer<M>

where M: AvailableMemory + Clone,

fn clone(&self) -> MemoryLimitLayer<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M> Debug for MemoryLimitLayer<M>

where M: AvailableMemory + Debug,

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

Formats the value using the given formatter.

impl<S, M> Layer<S> for MemoryLimitLayer<M>

where M: AvailableMemory,

type Service = MemoryLimit<S, M>

The wrapped service

fn layer(&self, service: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.