Skip to main content

AppHandle

Struct AppHandle 

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

Handle to a running application.

Owns the root region and provides stop / join lifecycle operations.

§Drop semantics

Panics on drop if neither stop nor join has been called (leak-preventing bomb, matching GradedObligation). Call AppHandle::into_raw to opt out of this guarantee when you know what you’re doing.

Implementations§

Source§

impl AppHandle

Source

pub fn name(&self) -> &str

Application name.

Source

pub fn root_region(&self) -> RegionId

The root region owned by this application.

Source

pub fn supervisor(&self) -> &SupervisorHandle

The supervisor handle for the app’s root supervisor.

Source

pub fn registry(&self) -> Option<&RegistryHandle>

The registry capability handle, if the app was started with one.

Source

pub fn stop(self, state: &mut RuntimeState) -> Result<StoppedApp, AppStopError>

Request cancellation of the application root region.

This initiates the cancel-correct shutdown sequence: close → drain → finalize → quiescence.

After calling stop, the region will transition through its lifecycle states. Use AppHandle::is_stopped or poll the region state to determine when quiescence is reached.

Source

pub fn is_stopped(&self, state: &RuntimeState) -> bool

Check whether the app’s root region has reached terminal (Closed) state.

Source

pub fn is_quiescent(&self, state: &RuntimeState) -> bool

Check whether the app’s root region is quiescent (no live tasks, no pending obligations, no finalizers).

Source

pub fn join(self, state: &RuntimeState) -> Result<StoppedApp, AppStopError>

Wait for the application’s root region to reach a terminal state.

Returns the terminal region state. In Phase 0 (synchronous runtime), this polls the region state; in async runtimes, this would await region completion.

Source

pub fn into_raw(self) -> RawAppHandle

Escape hatch: consume the handle without requiring stop/join.

Returns the raw region ID. The caller assumes responsibility for lifecycle management of the root region.

Trait Implementations§

Source§

impl Debug for AppHandle

Source§

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

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

impl Drop for AppHandle

Source§

fn drop(&mut self)

Executes the destructor for this 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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<T> Same for T

Source§

type Output = T

Should always be Self
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more