View Source Spear.StreamMetadata (Spear v1.4.1)

A struct for describing the metadata about a stream

Summary

Types

t()

Internal and custom metadata about a stream

Functions

to_map(metadata)

Converts a stream metadata struct to a map in the format EventStoreDB expects

Types

t()

(since 0.1.3)

@type t() :: %Spear.StreamMetadata{
  acl: Spear.Acl.t() | nil,
  cache_control: pos_integer() | nil,
  custom: %{required(String.t()) => any()} | nil,
  max_age: pos_integer() | nil,
  max_count: pos_integer() | nil,
  truncate_before: pos_integer() | nil
}

Internal and custom metadata about a stream

See the EventStoreDB stream metadata documentation for more details.

Functions

to_map(metadata)

Converts a stream metadata struct to a map in the format EventStoreDB expects