Skip to main content

PhaseLeaser

Struct PhaseLeaser 

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

The phase leaser manages phase transitions and capability grants. Capabilities are leased for the duration of a phase and automatically revoked when the phase ends or an interrupt occurs.

Implementations§

Source§

impl PhaseLeaser

Source

pub fn new() -> Self

Creates a new PhaseLeaser.

Source

pub fn register_phase(&mut self, phase: Phase) -> Result<(), LeaseError>

Register a phase.

Source

pub fn enter_phase(&mut self, phase_name: &str) -> Result<(), LeaseError>

Enter a phase. This revokes all previously leased capabilities and grants the capabilities allowed in the new phase.

Source

pub fn exit_phase(&mut self)

Exit the current phase. Revokes all leased capabilities.

Source

pub fn is_leased(&self, cap: &str) -> bool

Check if a capability is currently leased (allowed).

Source

pub fn verify_capability( &mut self, cap: &str, node_id: Option<u32>, ) -> Result<(), LeaseError>

Verify that a capability use is allowed. If not, trigger an interrupt. Returns Ok(()) if allowed, Err(LeaseError) if not.

Source

pub fn trigger_interrupt(&mut self, interrupt: DeonticInterrupt)

Trigger a deontic interrupt. Immediately revokes all capabilities and marks the leaser as interrupted.

Source

pub fn manual_interrupt(&mut self, description: &str)

Manually trigger an interrupt (e.g., from governance).

Source

pub fn resume(&mut self) -> Result<(), LeaseError>

Clear the interrupted state and resume (if allowed). This re-grants capabilities for the current phase.

Source

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

Get the currently active phase name.

Source

pub fn interrupts(&self) -> &[DeonticInterrupt]

Get the interrupt history.

Source

pub fn interrupts_overflowed(&self) -> u64

Number of interrupt events omitted after the bounded history filled.

Source

pub fn is_interrupted(&self) -> bool

Is the leaser in an interrupted state?

Source

pub fn phase_count(&self) -> usize

Get the number of registered phases.

Source

pub fn leased_count(&self) -> usize

Get the number of currently leased capabilities.

Trait Implementations§

Source§

impl Clone for PhaseLeaser

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 Default for PhaseLeaser

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,