KernelHandle

Struct KernelHandle 

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

Handle to a launched kernel.

Provides an ergonomic API for interacting with a kernel.

Implementations§

Source§

impl KernelHandle

Source

pub fn new(id: KernelId, inner: Arc<dyn KernelHandleInner>) -> Self

Create a new kernel handle.

Source

pub fn id(&self) -> &KernelId

Get the kernel ID.

Source

pub async fn activate(&self) -> Result<()>

Activate the kernel.

Source

pub async fn deactivate(&self) -> Result<()>

Deactivate the kernel.

Source

pub async fn terminate(&self) -> Result<()>

Terminate the kernel.

Source

pub async fn send<M: RingMessage>(&self, message: M) -> Result<()>

Send a message to the kernel.

Source

pub async fn send_envelope(&self, envelope: MessageEnvelope) -> Result<()>

Send a raw envelope.

Source

pub async fn receive(&self) -> Result<MessageEnvelope>

Receive a message from the kernel.

Source

pub async fn receive_timeout( &self, timeout: Duration, ) -> Result<MessageEnvelope>

Receive a message with timeout.

Source

pub fn try_receive(&self) -> Result<MessageEnvelope>

Try to receive a message (non-blocking).

Source

pub async fn call<M: RingMessage>( &self, message: M, timeout: Duration, ) -> Result<MessageEnvelope>

Send request and wait for response (call pattern).

Source

pub fn status(&self) -> KernelStatus

Get kernel status.

Source

pub fn metrics(&self) -> KernelMetrics

Get kernel metrics.

Source

pub async fn wait(&self) -> Result<()>

Wait for kernel to terminate.

Source

pub fn state(&self) -> KernelState

Get the current kernel state.

This is a convenience method that returns just the state from status().

Source

pub async fn suspend(&self) -> Result<()>

Suspend (deactivate) the kernel.

This is an alias for deactivate() for more intuitive API usage.

Source

pub async fn resume(&self) -> Result<()>

Resume (activate) the kernel.

This is an alias for activate() for more intuitive API usage.

Source

pub fn is_active(&self) -> bool

Check if the kernel is currently active.

Source

pub fn is_terminated(&self) -> bool

Check if the kernel has terminated.

Trait Implementations§

Source§

impl Clone for KernelHandle

Source§

fn clone(&self) -> KernelHandle

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KernelHandle

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

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<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

Source§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

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

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The type for metadata in pointers and references to Self.
§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

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

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

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.