Enum fred::types::BackpressurePolicy

pub enum BackpressurePolicy {
    Sleep {
        disable_backpressure_scaling: bool,
        min_sleep_duration: Duration,
    },
    Drain,
}

Backpressure policies to apply when the max number of in-flight commands is reached on a connection.

Variants

Sleep

Sleep for some amount of time before sending the next command.

Fields

disable_backpressure_scaling: bool

Disable the backpressure scaling logic used to calculate the sleep duration when throttling commands.

If true the client will always wait a constant amount of time defined by min_sleep_duration_ms when throttling commands. Otherwise the sleep duration will scale based on the number of in-flight commands.

Default: false

min_sleep_duration: Duration

The minimum amount of time to wait when applying backpressure to a command.

If 0 then no backpressure will be applied, but backpressure errors will not be surfaced to callers unless disable_auto_backpressure is true.

Default: 10 ms

Drain

Wait for all in-flight commands to finish before sending the next command.

Implementations

impl BackpressurePolicy

pub fn default_sleep() -> Self

Create a new Sleep policy with the legacy default values.

Trait Implementations

impl Clone for BackpressurePolicy

fn clone(&self) -> BackpressurePolicy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BackpressurePolicy

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

Formats the value using the given formatter.

impl Default for BackpressurePolicy

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for BackpressurePolicy

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BackpressurePolicy

impl StructuralPartialEq for BackpressurePolicy