Struct eventstore::StreamMetadata

pub struct StreamMetadata {
    pub max_count: Option<u64>,
    pub max_age: Option<Duration>,
    pub truncate_before: Option<u64>,
    pub cache_control: Option<Duration>,
    pub acl: StreamAcl,
    pub custom_properties: HashMap<String, Value>,
}

Represents stream metadata with strongly types properties for system values and a dictionary-like interface for custom values.

Fields

max_count: Option<u64>

A sliding window based on the number of items in the stream. When data reaches a certain length it disappears automatically from the stream and is considered eligible for scavenging.

max_age: Option<Duration>

A sliding window based on dates. When data reaches a certain age it disappears automatically from the stream and is considered eligible for scavenging.

truncate_before: Option<u64>

The event number from which previous events can be scavenged. This is used to implement soft-deletion of streams.

cache_control: Option<Duration>

Controls the cache of the head of a stream. Most URIs in a stream are infinitely cacheable but the head by default will not cache. It may be preferable in some situations to set a small amount of caching on the head to allow intermediaries to handle polls (say 10 seconds).

acl: StreamAcl

The access control list for the stream.

custom_properties: HashMap<String, Value>

An enumerable of key-value pairs of keys to JSON value for user-provided metadata.

Implementations

impl StreamMetadata

pub fn builder() -> StreamMetadataBuilder

Initializes a fresh stream metadata builder.

Trait Implementations

impl Clone for StreamMetadata

pub fn clone(&self) -> StreamMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamMetadata

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

Formats the value using the given formatter.

impl Default for StreamMetadata

pub fn default() -> StreamMetadata

Returns the "default value" for a type.