Struct CheckpointBarrier 

#[repr(C)]
pub struct CheckpointBarrier {
    pub checkpoint_id: u64,
    pub epoch: u64,
    pub flags: u64,
}

A checkpoint barrier that flows through the dataflow graph.

This is a 24-byte #[repr(C)] value type that can be cheaply copied and embedded in channel messages. It carries the checkpoint identity and behavior flags.

Layout (24 bytes)

Field	Offset	Size	Description
checkpoint_id	0	8	Unique checkpoint ID
epoch	8	8	Monotonic epoch number
flags	16	8	Behavior flags (see flags)

Fields

checkpoint_id: u64

Unique identifier for this checkpoint.

epoch: u64

Monotonically increasing epoch number.

flags: u64

Behavior flags (see flags module constants).

Implementations

impl CheckpointBarrier

pub const fn new(checkpoint_id: u64, epoch: u64) -> Self

Create a new barrier with the given checkpoint ID and epoch.

pub const fn full_snapshot(checkpoint_id: u64, epoch: u64) -> Self

Create a barrier that requests a full snapshot.

pub const fn is_full_snapshot(&self) -> bool

Check whether this barrier requests a full (non-incremental) snapshot.

pub const fn is_drain(&self) -> bool

Check whether this barrier signals drain/shutdown.

pub const fn is_cancel(&self) -> bool

Check whether this barrier cancels an in-progress checkpoint.

pub const fn is_unaligned(&self) -> bool

Check whether this barrier is from an unaligned checkpoint.

Trait Implementations

impl Clone for CheckpointBarrier

fn clone(&self) -> CheckpointBarrier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckpointBarrier

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

Formats the value using the given formatter.

impl Hash for CheckpointBarrier

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 CheckpointBarrier

fn eq(&self, other: &CheckpointBarrier) -> 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 Copy for CheckpointBarrier

impl Eq for CheckpointBarrier

impl StructuralPartialEq for CheckpointBarrier