GroundPlane.Contracts.Checkpoint (GroundPlane Contracts v0.1.0)

Copy Markdown View Source

Shared checkpoint vocabulary for replay and projection positions.

Summary

Types

t()

Functions

advance(checkpoint, next_position, reason)
new(attrs)

Types

t()

@type t() :: %GroundPlane.Contracts.Checkpoint{
  persistence_posture: map() | nil,
  position: non_neg_integer(),
  reason: String.t(),
  stream: String.t()
}

Functions

advance(checkpoint, next_position, reason)

@spec advance(t(), non_neg_integer(), String.t()) :: {:ok, t()} | {:error, term()}

new(attrs)

@spec new(map()) :: {:ok, t()} | {:error, term()}