Skip to main content

ContextCheckpointV1

Struct ContextCheckpointV1 

Source
pub struct ContextCheckpointV1 {
    pub schema_version: u32,
    pub identity: ContextCheckpointIdentityV1,
    pub lineage: ContextCheckpointLineageV1,
    pub live_state: ContextCheckpointLiveStateV1,
    pub carrier: Option<ContextCheckpointCarrierBindingV1>,
    pub engine_version: SemanticVersion,
    pub created_at: UtcTimestamp,
    pub updated_at: UtcTimestamp,
    pub encryption_metadata: Option<ContextCheckpointEncryptionMetadataV1>,
}
Expand description

Canonical typed live-state checkpoint.

Fields§

§schema_version: u32

Schema version of the checkpoint contract.

§identity: ContextCheckpointIdentityV1

Parent, branch, and device identity.

§lineage: ContextCheckpointLineageV1

Work-graph lineage references.

§live_state: ContextCheckpointLiveStateV1

Portable live state.

§carrier: Option<ContextCheckpointCarrierBindingV1>

Binding to a P6 carrier envelope, when the checkpoint travels in one.

§engine_version: SemanticVersion

Engine version that produced the checkpoint.

§created_at: UtcTimestamp

Canonical UTC creation timestamp.

§updated_at: UtcTimestamp

Canonical UTC timestamp of the latest portable semantic update.

§encryption_metadata: Option<ContextCheckpointEncryptionMetadataV1>

Metadata for an encrypted downstream projection, when present.

Implementations§

Source§

impl ContextCheckpointV1

Source

pub const SCHEMA_VERSION: u32 = 1

Schema version represented by this type.

Source

pub const SCHEMA_ID: &'static str = CONTEXT_CHECKPOINT_SCHEMA_ID

Schema identity represented by this type.

Source

pub fn try_new( identity: ContextCheckpointIdentityV1, lineage: ContextCheckpointLineageV1, live_state: ContextCheckpointLiveStateV1, carrier: Option<ContextCheckpointCarrierBindingV1>, engine_version: SemanticVersion, created_at: UtcTimestamp, ) -> Result<Self, ValidationError>

Construct a validated checkpoint.

This is the only way to obtain a ContextCheckpointV1 that is known valid at construction time; every digest and signing API revalidates because the fields remain publicly assignable.

Source

pub fn with_optional_metadata( self, encryption_metadata: Option<ContextCheckpointEncryptionMetadataV1>, ) -> Result<Self, ValidationError>

Attach optional portable metadata through a fallible API.

Source

pub fn with_updated_at( self, updated_at: UtcTimestamp, ) -> Result<Self, ValidationError>

Set the portable semantic update timestamp.

Source

pub fn with_portable_state( self, session_state: Option<ContextCheckpointSessionStateV1>, learning_state: Option<ContextCheckpointLearningStateV1>, encryption_metadata: Option<ContextCheckpointEncryptionMetadataV1>, ) -> Result<Self, ValidationError>

Attach all optional portable continuation state through a fallible API.

Source

pub fn validate(&self) -> Result<(), ValidationError>

Validate every invariant, including the cross-field bindings.

Source

pub fn canonical_bytes(&self) -> Result<Vec<u8>, ValidationError>

Return canonical compact JSON bytes with lexicographically sorted keys.

Source

pub fn canonical_json(&self) -> Result<String, ValidationError>

Return the canonical JSON encoding as UTF-8 text.

Source

pub fn from_canonical_bytes(bytes: &[u8]) -> Result<Self, ValidationError>

Decode exactly canonical JSON and validate every invariant.

Source

pub fn from_legacy_v1_canonical_bytes( bytes: &[u8], authenticated_tenant_id: TenantId, ) -> Result<Self, ValidationError>

Migrate a canonical legacy-v1 checkpoint that predates mandatory tenant binding.

The caller must supply the authenticated tenant context; this function never guesses or derives a tenant from untrusted checkpoint fields. Payloads already carrying a tenant must use Self::from_canonical_bytes instead.

Source

pub fn digest(&self) -> Result<Sha256Digest, ValidationError>

Domain-separated content identity of the whole checkpoint.

Source

pub fn digest_inputs( &self, ) -> Result<ContextCheckpointDigestInputsV1, ValidationError>

Domain-separated digest inputs consumed by downstream slices.

Source

pub fn signing_payload( &self, ) -> Result<ContextCheckpointSigningPayloadV1, ValidationError>

Build the sealed payload a downstream signer may cover.

Trait Implementations§

Source§

impl Clone for ContextCheckpointV1

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ContextCheckpointV1

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ContextCheckpointV1

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for ContextCheckpointV1

Source§

impl PartialEq for ContextCheckpointV1

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ContextCheckpointV1

Source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ContextCheckpointV1

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> 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.