Struct SourceCheckpoint 

pub struct SourceCheckpoint { /* private fields */ }

Checkpoint state for a source connector.

Captures the connector’s position using string key-value pairs. This is flexible enough to represent:

• Kafka: {"events:0": "1234", "events:1": "5678"}
• PostgreSQL CDC: {"lsn": "0/1234ABCD"}
• File: {"manifest": "[...]", "file_progress": "..."}

This payload deliberately has no checkpoint epoch or attempt identifier. The barrier protocol and top-level manifest bind it to an exact attempt. Ordinary offsets remain eager; connectors with large append-only positions can opt into PersistentOffset without changing the compatibility API.

Implementations

impl SourceCheckpoint

pub fn new() -> Self

Creates an empty checkpoint.

pub fn with_offsets(offsets: HashMap<String, String>) -> Self

Creates a checkpoint with the given connector-specific offsets.

pub fn set_offset(&mut self, key: impl Into<String>, value: impl Into<String>)

Sets an offset value.

pub fn set_persistent_offset( &mut self, key: impl Into<String>, value: PersistentOffset, )

Sets a large offset value backed by an immutable fragment log.

This replaces any eager value under the same key. The value remains lazy across checkpoint clones until Self::get_offset, Self::offsets, or Self::durable_offsets explicitly requests it.

pub fn get_offset(&self, key: &str) -> Option<&str>

Gets an offset value.

pub fn offsets(&self) -> &HashMap<String, String>

Returns all offsets.

pub fn durable_offsets(&self) -> HashMap<String, String>

Materializes all offsets into an owned map for durable checkpoint conversion.

If the compatibility view has not been requested, persistent values are written directly into the returned map and are not retained as a second full copy inside this checkpoint.

pub fn set_metadata(&mut self, key: impl Into<String>, value: impl Into<String>)

Sets metadata on the checkpoint.

pub fn get_metadata(&self, key: &str) -> Option<&str>

Gets metadata from the checkpoint.

pub fn metadata(&self) -> &HashMap<String, String>

Returns all metadata.

pub fn bind_assignment_version(&mut self, assignment_version: NonZeroU64)

Binds this source cut to the exact partition-assignment publication that owns it.

pub const fn assignment_version(&self) -> Option<NonZeroU64>

Returns the partition-assignment publication that owns this source cut.

pub fn is_empty(&self) -> bool

Returns true if the checkpoint has no offsets.

Trait Implementations

impl Clone for SourceCheckpoint

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 SourceCheckpoint

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

Formats the value using the given formatter.

impl Default for SourceCheckpoint

fn default() -> Self

Returns the “default value” for a type.

impl Eq for SourceCheckpoint

impl PartialEq for SourceCheckpoint

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

Equality operator ==.

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

Inequality operator !=.