Struct eventstore::StreamMetadataBuilder

pub struct StreamMetadataBuilder { /* private fields */ }

Used to facilitate the creation of a stream’s metadata.

Implementations

impl StreamMetadataBuilder

pub fn new() -> StreamMetadataBuilder

Creates a StreamMetadata initialized with default values.

pub fn max_count(self, value: u64) -> StreamMetadataBuilder

Sets 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.

pub fn max_age(self, value: Duration) -> StreamMetadataBuilder

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

pub fn truncate_before(self, value: u64) -> StreamMetadataBuilder

Sets the event number from which previous events can be scavenged.

pub fn cache_control(self, value: Duration) -> StreamMetadataBuilder

This 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).

pub fn acl(self, value: Acl) -> StreamMetadataBuilder

Sets the ACL of a stream.

pub fn insert_custom_property<V>( self, key: impl AsRef<str>, value: V ) -> StreamMetadataBuilder

where V: Serialize,

Adds user-defined property in the stream metadata.

pub fn build(self) -> StreamMetadata

Returns a properly configured StreamMetaData.

Trait Implementations

impl Default for StreamMetadataBuilder

fn default() -> StreamMetadataBuilder

Returns the “default value” for a type.