Struct CauseCapsule 

pub struct CauseCapsule<'a> { /* private fields */ }

Validated compact event capsule for causal parentage.

Implementations

impl<'a> CauseCapsule<'a>

pub const fn new( parts: CauseCapsuleParts<'a>, limits: WireLimits, ) -> Result<Self, ValidationError>

Creates a validated compact cause capsule.

pub const fn validate(&self, limits: WireLimits) -> Result<(), ValidationError>

Validates bounded capsule shape.

pub const fn event_id(&self) -> EventId

Returns the local event identifier.

pub const fn parents(&self) -> &'a [EventId]

Returns parent event identifiers.

pub const fn relationship(&self) -> RelationshipKind

Returns the relationship used for each parent.

pub const fn cause_kind(&self) -> CauseKind

Returns the observable cause class.

pub const fn action(&self) -> OperationAction

Returns the requested action.

pub const fn authority(&self) -> Option<CapabilityRef>

Returns the optional authority reference.

pub const fn policy_epoch(&self) -> Option<PolicyEpoch>

Returns the optional policy epoch reference.

Trait Implementations

impl<'a> Clone for CauseCapsule<'a>

fn clone(&self) -> CauseCapsule<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for CauseCapsule<'a>

impl<'a> Debug for CauseCapsule<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for CauseCapsule<'a>

impl<'a> PartialEq for CauseCapsule<'a>

fn eq(&self, other: &CauseCapsule<'a>) -> 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<'a> StructuralPartialEq for CauseCapsule<'a>