Struct Checkpoint 

pub struct Checkpoint(/* private fields */);

A bounded, versioned reader position committed with a chunk.

Implementations

impl Checkpoint

pub fn encode<T>( value: &T, codec: &(impl VersionedStateCodec<T> + ?Sized), limits: StateLimits, ) -> Result<Self, StateError>

Encodes a current typed value with explicit resource limits.

Errors

Returns a redacted codec, schema, JSON-shape, size, or depth failure.

pub fn from_json(bytes: &[u8], limits: StateLimits) -> Result<Self, StateError>

Validates a serialized framework envelope before retaining it.

Errors

Returns a redacted format, schema, shape, size, or depth failure.

pub fn decode<T>( &self, codec: &(impl VersionedStateCodec<T> + ?Sized), ) -> Result<T, StateError>

Decodes or upgrades the retained payload through codec.

Errors

Returns a redacted schema-compatibility or codec failure.

pub const fn format_version(&self) -> u16

Returns the framework envelope format version.

pub const fn schema_id(&self) -> &StateSchemaId

Borrows the validated application schema identifier.

pub const fn schema_version(&self) -> StateSchemaVersion

Returns the retained application schema version.

pub const fn encoded_len(&self) -> usize

Returns the validated serialized-envelope byte size.

pub fn to_json(&self) -> Result<Vec<u8>, StateError>

Serializes the complete framework envelope.

Errors

Returns a redacted format failure if the retained JSON value cannot be serialized.

pub fn payload_json(&self) -> Result<Vec<u8>, StateError>

Serializes only the application payload for an authorized persistence adapter.

This value can contain sensitive restart data and must not be logged or exported as telemetry.

Errors

Returns a redacted format failure if the retained JSON value cannot be serialized.

impl Checkpoint

pub fn generation_digest(&self) -> [u8; 32]

Returns the framework digest identifying this checkpoint generation.

Retry keys are derived from the generation, so the runtime and every durable adapter must agree on this exact derivation.

Trait Implementations

impl Clone for Checkpoint

fn clone(&self) -> Checkpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Checkpoint

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

Formats the value using the given formatter.

impl Eq for Checkpoint

impl PartialEq for Checkpoint

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Checkpoint