Struct StreamBookmark 

pub struct StreamBookmark {
    pub stream_arn: Option<String>,
    pub shards: BTreeMap<String, String>,
    pub finished: BTreeSet<String>,
    pub verified_at: BTreeMap<String, i64>,
}

Streams bookmark.

Fields

stream_arn: Option<String>

Stream the positions belong to.

shards: BTreeMap<String, String>

Shard id → last emitted sequence number ("" = opened, nothing read).

finished: BTreeSet<String>

Closed shards fully drained.

verified_at: BTreeMap<String, i64>

Empty-position shard → unix seconds it was last known to hold nothing unread.

Implementations

impl StreamBookmark

pub fn from_value(v: &Value) -> Self

Parse; malformed values are treated as absent.

pub fn parse(v: &Value) -> Result<Self, FaucetError>

Parse a stored bookmark; null is absent, anything unparseable is an error so a stream never silently restarts at start_position. A field a streams bookmark never carries (a scan bookmark’s segments, say) is refused too: every known field is optional, so such an object would otherwise read as an empty bookmark.

pub fn to_value(&self) -> Value

Serialize.

pub fn is_empty(&self) -> bool

Whether this bookmark records any progress.

pub fn open(&mut self, shard: &str)

Record that a shard was opened (keeps an existing position).

pub fn open_at(&mut self, shard: &str, now: i64)

open at an explicit time.

pub fn verify_empty(&mut self, shard: &str, now: i64)

An empty-position shard was read to its end: nothing retained is unread.

pub fn advance(&mut self, shard: &str, sequence: &str)

Record a shard’s newest emitted sequence.

pub fn finish(&mut self, shard: &str)

Record a closed shard as fully drained.

pub fn prune_finished( &mut self, existing: &BTreeSet<String>, parents: &BTreeSet<String>, )

Drop finished entries no longer needed: keep a finished shard while it still exists or is the parent of one that does.

Trait Implementations

impl Clone for StreamBookmark

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamBookmark

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

Formats the value using the given formatter.

impl Default for StreamBookmark

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StreamBookmark

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for StreamBookmark

impl PartialEq for StreamBookmark

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StreamBookmark

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 StreamBookmark