Struct ContextFact 

pub struct ContextFact { /* private fields */ }

Read-only projection of a validated assertion in the context.

This type is not promotion authority. It is the value suggestors and pack authors can read from context after the engine has promoted a proposal. Constructing one locally does not admit it into Converge; there is no public API that accepts a ContextFact as promoted truth.

Implementations

impl ContextFact

pub fn new_projection<T>( key: ContextKey, id: impl Into<FactId>, payload: T, promotion_record: FactPromotionRecord, created_at: impl Into<Timestamp>, ) -> ContextFact

where T: FactPayload + PartialEq,

Creates a read-only context projection.

This constructor does not promote anything and is intentionally named as a projection constructor. The engine is still the only component that can add context facts to a live ContextState.

pub fn from_wire( wire: WireContextFact, registry: &PayloadRegistry, ) -> Result<ContextFact, PayloadError>

Creates a context fact from a wire representation at a serialization border.

pub fn to_wire(&self) -> Result<WireContextFact, PayloadError>

Converts this fact to the stable wire shape.

pub fn key(&self) -> ContextKey

Returns the context key this fact belongs to.

pub fn id(&self) -> &FactId

Returns the fact identifier.

pub fn payload<T>(&self) -> Option<&T>

where T: FactPayload,

Returns the typed payload when the requested type matches the stored payload family/version.

pub fn require_payload<T>(&self) -> Result<&T, PayloadError>

where T: FactPayload,

Returns the typed payload or a mismatch error.

pub fn payload_family(&self) -> FactFamilyId

Returns the payload family.

pub fn payload_version(&self) -> PayloadVersion

Returns the payload version.

pub fn text(&self) -> Option<&str>

Returns the payload as text when this is a TextPayload.

pub fn validate_payload(&self) -> Result<(), PayloadError>

Validates the stored payload.

pub fn promotion_record(&self) -> &FactPromotionRecord

Returns the immutable promotion record for this fact.

pub fn created_at(&self) -> &Timestamp

Returns the fact creation timestamp.

pub fn is_replay_eligible(&self) -> bool

Returns whether the fact is replay-eligible.

Trait Implementations

impl Clone for ContextFact

fn clone(&self) -> ContextFact

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContextFact

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

Formats the value using the given formatter.

impl PartialEq for ContextFact

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ContextFact