Enum vector_buffers::config::BufferType

pub enum BufferType {
    Memory {
        max_events: NonZeroUsize,
        when_full: WhenFull,
    },
    DiskV2 {
        max_size: NonZeroU64,
        when_full: WhenFull,
    },
}

A specific type of buffer stage.

Variants

Memory

A buffer stage backed by an in-memory channel provided by tokio.

This is more performant, but less durable. Data will be lost if Vector is restarted forcefully or crashes.

Fields

max_events: NonZeroUsize

The maximum number of events allowed in the buffer.

when_full: WhenFull

DiskV2

A buffer stage backed by disk.

This is less performant, but more durable. Data that has been synchronized to disk will not be lost if Vector is restarted forcefully or crashes.

Data is synchronized to disk every 500ms.

Fields

max_size: NonZeroU64

The maximum size of the buffer on disk.

Must be at least ~256 megabytes (268435488 bytes).

when_full: WhenFull

Implementations

impl BufferType

pub fn disk_usage( &self, global_data_dir: Option<PathBuf>, id: &ComponentKey, ) -> Option<DiskUsage>

Gets the metadata around disk usage by the buffer, if supported.

For buffer types that write to disk, Some(value) is returned with their usage metadata, such as maximum size and data directory path.

Otherwise, None is returned.

pub fn add_to_builder<T>( &self, builder: &mut TopologyBuilder<T>, data_dir: Option<PathBuf>, id: String, ) -> Result<(), BufferBuildError>

where T: Bufferable + Clone + Finalizable,

Adds this buffer type as a stage to an existing TopologyBuilder.

Errors

If a required parameter is missing, or if there is an error building the topology itself, an error variant will be returned describing the error

Trait Implementations

impl Clone for BufferType

fn clone(&self) -> BufferType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for BufferType

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 BufferType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BufferType

fn deserialize<D>(deserializer: D) -> Result<BufferType, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BufferType

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for BufferType

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 BufferType

fn to_value(&self) -> Value

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

impl Copy for BufferType

impl Eq for BufferType

impl StructuralPartialEq for BufferType