Struct StreamCursorRef 

pub struct StreamCursorRef {
    pub position: ReplayCursor,
    pub created_at: DateTime<Utc>,
    pub metadata: Metadata,
}

Stable durable reference to a family-aware stream replay position.

Fields

position: ReplayCursor

Canonical stream cursor. Family, scope, sequence, and backend position live here once.

created_at: DateTime<Utc>

Creation time.

metadata: Metadata

Cursor metadata.

Implementations

impl StreamCursorRef

pub fn new(position: ReplayCursor) -> Self

Build a durable reference from a canonical cursor.

pub const fn family(&self) -> ReplayCursorFamily

Return the cursor family.

pub const fn scope(&self) -> &ReplayScope

Return the cursor scope.

pub const fn sequence(&self) -> usize

Return the last observed sequence.

pub fn same_stream(&self, other: &Self) -> bool

Return whether two references address the same stream family and scope.

pub fn validate_for_run( &self, run_id: &RunId, ) -> Result<(), StreamCursorRefError>

Validate that this cursor belongs to the supplied run scope.

Errors

Returns an error when the cursor addresses another run or a non-run scope.

pub fn validate_progression( &self, current: &Self, ) -> Result<(), StreamCursorRefError>

Validate that replacing an existing same-stream cursor does not regress.

Errors

Returns an error when the proposed sequence is behind the current sequence.

Trait Implementations

impl Clone for StreamCursorRef

fn clone(&self) -> StreamCursorRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamCursorRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamCursorRef

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for StreamCursorRef

impl PartialEq for StreamCursorRef

fn eq(&self, other: &StreamCursorRef) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for StreamCursorRef

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StreamCursorRef