Skip to main content

QueueConfig

Struct QueueConfig 

Source
#[non_exhaustive]
pub struct QueueConfig { pub depth_bytes: usize, pub depth_objects: usize, pub max_hold: Option<Duration>, pub overflow: Overflow, pub on_expiry: Expiry, }
Expand description

The per-stream queue policy: how deep, how long, and what happens at each limit.

#[non_exhaustive] with a Default — see the module doc.

The Default is hand-written, not derived: a derived one would give depth_bytes == 0 and depth_objects == 0, which ShapeProfile::try_new rejects as ShapeError::EmptyQueue — so QueueConfig::default() would be a value that cannot be used, and the ..Default::default() idiom this type is built for would fail on every profile that did not restate both depths.

That hand-written Default is also what the written form defaults every key to, so a scenario file may omit queue entirely or name only the one knob it cares about. It is the one config in this module where the derived default would be the unusable value and the written default is therefore worth having.

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.
§depth_bytes: usize

Bytes one stream’s queue may hold. Defaults to 1 MiB, matching EgressConfig::max_pending_bytes.

§depth_objects: usize

Objects one stream’s queue may hold. Defaults to 256 — a limit the byte depth does not imply, since a queue of small objects reaches neither.

§max_hold: Option<Duration>

Deadline for a queued object, per class. None inherits EgressConfig::max_hold, which is 30 s.

Pin this explicitly in any fixture that relies on a class not delivering: under the default Expiry::Deliver a starved class still delivers at max_hold, so an unnamed 30 s is a margin the test inherited rather than chose.

§overflow: Overflow

What happens when the queue is full.

§on_expiry: Expiry

What happens when a queued object outlives max_hold.

Trait Implementations§

Source§

impl Clone for QueueConfig

Source§

fn clone(&self) -> QueueConfig

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 QueueConfig

Source§

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

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

impl Default for QueueConfig

Source§

fn default() -> Self

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

impl Eq for QueueConfig

Source§

impl PartialEq for QueueConfig

Source§

fn eq(&self, other: &QueueConfig) -> 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 QueueConfig

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