Enum vector_buffers::WhenFull

pub enum WhenFull {
    Block,
    DropNewest,
    Overflow,
}

Event handling behavior when a buffer is full.

Variants

Block

Wait for free space in the buffer.

This applies backpressure up the topology, signalling that sources should slow down the acceptance/consumption of events. This means that while no data is lost, data will pile up at the edge.

DropNewest

Drops the event instead of waiting for free space in buffer.

The event will be intentionally dropped. This mode is typically used when performance is the highest priority, and it is preferable to temporarily lose events rather than cause a slowdown in the acceptance/consumption of events.

Overflow

Overflows to the next stage in the buffer topology.

If the current buffer stage is full, attempt to send this event to the next buffer stage. That stage may also be configured overflow, and so on, but ultimately the last stage in a buffer topology must use one of the other handling behaviors. This means that next stage may potentially be able to buffer the event, but it may also block or drop the event.

This mode can only be used when two or more buffer stages are configured.

Trait Implementations

impl Clone for WhenFull

fn clone(&self) -> WhenFull

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for WhenFull

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for WhenFull

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

Formats the value using the given formatter.

impl Default for WhenFull

fn default() -> WhenFull

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WhenFull

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WhenFull

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for WhenFull

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.

impl Copy for WhenFull

impl Eq for WhenFull

impl StructuralPartialEq for WhenFull