Struct eventstore::types::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>

The maximum number of events allowed in the stream.

max_age: Option<Duration>

The maximum age of events allowed in the stream.

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>

The amount of time for which the stream head is cacheable.

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.

Methods

impl StreamMetadata

pub fn builder() -> StreamMetadataBuilder

Initializes a fresh stream metadata builder.

Trait Implementations

impl Debug for StreamMetadata

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

Formats the value using the given formatter.

impl Default for StreamMetadata

fn default() -> StreamMetadata

Returns the "default value" for a type.