Struct Cx 

pub struct Cx<Caps: SubsetOf<All> = FullCaps> { /* private fields */ }

Capability context passed through all effectful operations.

Carries tracing identifiers (trace_id, decision_id, policy_id) that propagate through all context derivations (clone, restrict, scope, child). A value of 0 means “unset / not assigned”.

Implementations

impl Cx<FullCaps>

pub fn new() -> Self

impl<Caps: SubsetOf<All>> Cx<Caps>

pub fn with_budget(budget: Budget) -> Self

pub fn budget(&self) -> Budget

pub fn trace_id(&self) -> u64

The trace ID for this context (0 = unset).

pub fn decision_id(&self) -> u64

The decision ID for this context (0 = unset).

pub fn policy_id(&self) -> u64

The policy ID for this context (0 = unset).

pub fn with_trace_context( self, trace_id: u64, decision_id: u64, policy_id: u64, ) -> Self

Set all three tracing identifiers at once.

Typically called once when a connection or request is initialized.

pub fn with_decision_id(self, decision_id: u64) -> Self

Return a new context with only the decision_id changed.

Used when starting a new operation within the same trace.

pub fn with_policy_id(self, policy_id: u64) -> Self

Return a new context with only the policy_id changed.

pub fn scope_with_budget(&self, child: Budget) -> Self

Returns a view of this context with a tighter effective budget.

The effective budget is computed as self.budget.meet(child), so the child cannot loosen its parent’s constraints. Tracing IDs propagate unchanged.

pub fn cleanup_scope(&self) -> Self

Returns a cleanup scope that uses Budget::MINIMAL.

pub fn restrict<NewCaps>(&self) -> Cx<NewCaps>

where NewCaps: SubsetOf<All> + SubsetOf<Caps>,

Re-type this context to a narrower capability set.

This is zero-cost at runtime and shares cancellation state.

pub fn is_cancel_requested(&self) -> bool

pub fn cancel(&self)

Request cancellation with the default reason (UserInterrupt).

Propagates to all child contexts per INV-CANCEL-PROPAGATES.

pub fn cancel_with_reason(&self, reason: CancelReason)

Request cancellation with an explicit reason.

INV-CANCEL-IDEMPOTENT: the strongest reason wins; weaker reasons are ignored once a stronger one has been set.

INV-CANCEL-PROPAGATES: cancellation propagates to all descendants.

pub fn cancel_state(&self) -> CancelState

Current state in the cancellation lifecycle.

pub fn cancel_reason(&self) -> Option<CancelReason>

The strongest cancellation reason set so far, if any.

pub fn transition_to_running(&self)

Transition from Created to Running.

pub fn transition_to_finalizing(&self)

Transition from Cancelling to Finalizing.

pub fn transition_to_completed(&self)

Transition to Completed (from Finalizing or Running).

pub fn set_eprocess_oracle(&self, oracle: Arc<EProcessOracle>)

Attach an e-process oracle used by Self::checkpoint.

pub fn clear_eprocess_oracle(&self)

Remove the currently attached e-process oracle.

pub fn set_native_cx(&self, native_cx: NativeCx)

Attach a native asupersync context used by Self::checkpoint.

pub fn attached_native_cx(&self) -> Option<NativeCx>

Return the attached native asupersync context, if one exists.

pub fn clear_native_cx(&self)

Remove the currently attached native asupersync context.

pub fn checkpoint(&self) -> Result<()>

Check for cancellation at a yield point.

Returns Ok(()) when not cancelled or when inside a masked section. When cancellation is observed, transitions state from CancelRequested to Cancelling.

pub fn checkpoint_with(&self, msg: impl Into<String>) -> Result<()>

Check for cancellation and record a progress message.

pub fn last_checkpoint_message(&self) -> Option<String>

pub fn last_eprocess_decision(&self) -> Option<EProcessDecision>

Most recent e-process decision recorded during Self::checkpoint.

pub fn last_eprocess_snapshot(&self) -> Option<EProcessSnapshot>

Snapshot portion of the most recent e-process decision.

pub fn masked(&self) -> MaskGuard<'_>

Enter a masked section where checkpoint() returns Ok(()) even if cancellation is requested.

Returns a MaskGuard whose Drop restores the mask depth.

Panics

Panics if nesting exceeds MAX_MASK_DEPTH (INV-MASK-BOUNDED).

pub fn mask_depth(&self) -> u32

Current mask nesting depth.

pub fn commit_section<R>( &self, poll_quota: u32, body: impl FnOnce(&CommitCtx) -> R, finalizer: impl FnOnce(), ) -> R

Execute a logically atomic commit section.

The section masks cancellation, enforces a poll quota bound, and guarantees the finalizer runs even on cancellation or panic.

pub fn create_child(&self) -> Self

Create a child Cx that shares the parent’s budget but has independent cancellation state. Cancelling the parent propagates to this child. Tracing IDs propagate to the child.

pub fn set_unix_millis_for_testing(&self, millis: u64)

where Caps: HasTime,

Set a deterministic unix time for tests.

pub fn current_time_julian_day(&self) -> f64

where Caps: HasTime,

Return current time as a Julian day (via deterministic unix millis).

Trait Implementations

impl<Caps: SubsetOf<All>> Clone for Cx<Caps>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Caps: Debug + SubsetOf<All>> Debug for Cx<Caps>

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

Formats the value using the given formatter.

impl Default for Cx<FullCaps>

fn default() -> Self

Returns the “default value” for a type.