Struct StreamCursor 

pub struct StreamCursor {
    pub block_number: u64,
    pub log_index: u32,
    pub version: u64,
}

An opaque cursor representing a position in the event stream.

Cursors are comparable and serializable, allowing consumers to persist their position and resume after restarts. The version field is bumped on reorgs to invalidate stale cursors.

Fields

block_number: u64

The block number of the last consumed event.

log_index: u32

The log index of the last consumed event within its block.

version: u64

Stream version — incremented on reorg to invalidate old cursors.

Implementations

impl StreamCursor

pub fn initial() -> Self

Create an initial cursor at the beginning of the stream.

This cursor represents “no events consumed yet” and will return all available events on the first next_batch call.

pub fn encode(&self) -> String

Serialize this cursor to a JSON string for persistence.

The encoded form can be stored in a database or sent over the wire, then decoded back with StreamCursor::decode.

pub fn decode(encoded: &str) -> Result<Self, IndexerError>

Deserialize a cursor from its encoded JSON string.

Returns an error if the string is not a valid cursor encoding.

Trait Implementations

impl Clone for StreamCursor

fn clone(&self) -> StreamCursor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamCursor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamCursor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for StreamCursor

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for StreamCursor

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StreamCursor

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for StreamCursor

impl StructuralPartialEq for StreamCursor