Skip to main content

OwnedSession

Struct OwnedSession 

Source
pub struct OwnedSession { /* private fields */ }
Expand description

Capability-bearing handle returned by the preferred owned open path.

Implementations§

Source§

impl OwnedSession

Source

pub fn session_id(&self) -> SessionId

Session identifier for this owned handle.

Source

pub fn capability(&self) -> &OwnershipCapability

Live ownership capability carried by this handle.

Source

pub fn apply_host_mutation( &self, machine: &mut ProtocolMachine, mutation: SessionHostMutation, ) -> Result<(), OwnershipError>

Apply one session-local host mutation through the ownership gate.

§Errors

Returns an OwnershipError if the capability is stale or lacks scope.

Source

pub fn issue_readiness_witness( &self, machine: &mut ProtocolMachine, predicate_ref: impl Into<String>, ) -> Result<ReadinessWitness, OwnershipError>

Issue a single-use readiness witness for a protocol-critical check.

§Errors

Returns an OwnershipError if the capability is stale or lacks session scope.

Source

pub fn consume_readiness_witness( &self, machine: &mut ProtocolMachine, witness: &ReadinessWitness, ) -> Result<(), OwnershipError>

Consume a previously issued readiness witness exactly once.

§Errors

Returns an OwnershipError if the witness is stale, forged, mismatched, or reused.

Source

pub fn begin_transfer( &self, machine: &mut ProtocolMachine, new_owner_id: impl Into<String>, new_scope: OwnershipScope, ) -> Result<OwnershipReceipt, OwnershipError>

Begin an explicit ownership transfer from this handle.

§Errors

Returns an OwnershipError if the capability is stale.

Source

pub fn commit_transfer( &self, machine: &mut ProtocolMachine, receipt: &OwnershipReceipt, ) -> Result<Self, OwnershipError>

Commit an explicit ownership transfer and return the refreshed handle.

§Errors

Returns an OwnershipError if the receipt is stale or mismatched.

Source

pub fn attenuate_scope( &self, machine: &mut ProtocolMachine, new_scope: OwnershipScope, ) -> Result<Self, OwnershipError>

Attenuate the handle scope and return the refreshed capability.

§Errors

Returns an OwnershipError if the capability is stale or transfer-pending.

Source

pub fn release( &self, machine: &mut ProtocolMachine, ) -> Result<(), OwnershipError>

Release the live ownership claim for this handle.

§Errors

Returns an OwnershipError if the capability is stale.

Source

pub fn mark_owner_died( &self, machine: &mut ProtocolMachine, ) -> Result<CancellationWitness, OwnershipError>

Fault the session because the current owner died.

§Errors

Returns an OwnershipError if the live owner no longer matches this handle.

Source

pub fn cancel_abandoned_transfer( &self, machine: &mut ProtocolMachine, receipt: &OwnershipReceipt, ) -> Result<CancellationWitness, OwnershipError>

Cancel the session because this transfer was abandoned.

§Errors

Returns an OwnershipError if the receipt no longer matches the live staged transfer.

Trait Implementations§

Source§

impl Clone for OwnedSession

Source§

fn clone(&self) -> OwnedSession

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OwnedSession

Source§

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

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

impl PartialEq for OwnedSession

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for OwnedSession

Source§

impl StructuralPartialEq for OwnedSession

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

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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> 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<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.