Skip to main content

StreamCheckpointManager

Struct StreamCheckpointManager 

Source
pub struct StreamCheckpointManager { /* private fields */ }
Expand description

Coordinates checkpoint lifecycle for streaming sources and sinks.

Disabled by default. When enabled via StreamCheckpointConfig, the manager captures atomic counters from registered sources to produce consistent StreamCheckpoint snapshots.

Implementations§

Source§

impl StreamCheckpointManager

Source

pub fn new(config: StreamCheckpointConfig) -> Self

Creates a new checkpoint manager.

If config validation fails, the manager is created in disabled state.

Source

pub fn disabled() -> Self

Creates a disabled (no-op) manager.

Source

pub fn is_enabled(&self) -> bool

Returns whether checkpointing is enabled.

Source

pub fn register_source( &mut self, name: &str, sequence: Arc<AtomicU64>, watermark: Arc<AtomicI64>, )

Registers a source for checkpoint tracking.

The sequence and watermark atomics are shared with the live Source — reading them is lock-free.

Source

pub fn register_sink(&mut self, name: &str, position: u64)

Registers a sink for checkpoint tracking.

Source

pub fn trigger(&mut self) -> Option<u64>

Triggers a checkpoint, capturing current source/sink state.

Returns the checkpoint ID, or None if checkpointing is disabled.

Source

pub fn checkpoint(&mut self) -> Result<Option<u64>, CheckpointError>

Creates a checkpoint and returns the checkpoint ID.

§Errors

Returns CheckpointError::Disabled if checkpointing is not enabled.

Source

pub fn restore(&self) -> Result<&StreamCheckpoint, CheckpointError>

Returns the most recent checkpoint for restore.

§Errors

Returns CheckpointError::Disabled if checkpointing is not enabled, or CheckpointError::NoCheckpoint if no checkpoint exists.

Source

pub fn get_checkpoint(&self, id: u64) -> Option<&StreamCheckpoint>

Returns a checkpoint by ID.

Source

pub fn last_checkpoint_id(&self) -> Option<u64>

Returns the ID of the most recent checkpoint.

Source

pub fn changelog(&self) -> Option<&StreamChangelogBuffer>

Returns a reference to the changelog buffer, if configured.

Source

pub fn changelog_mut(&mut self) -> Option<&mut StreamChangelogBuffer>

Returns a mutable reference to the changelog buffer.

Source

pub fn epoch(&self) -> u64

Returns the current epoch.

Trait Implementations§

Source§

impl Debug for StreamCheckpointManager

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,