Skip to main content

AsyncRuntime

Struct AsyncRuntime 

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

Manages the Tokio async runtime for a plugin

Implementations§

Source§

impl AsyncRuntime

Source

pub fn new(config: RuntimeConfig) -> PluginResult<Self>

Create a new async runtime with the given configuration

Source

pub fn with_defaults() -> PluginResult<Self>

Create a runtime with default configuration

Source

pub fn config(&self) -> &RuntimeConfig

Get the runtime configuration

Source

pub fn handle(&self) -> Handle

Get a handle to the underlying Tokio runtime

Source

pub fn shutdown_signal(&self) -> ShutdownSignal

Get a shutdown signal that can be used to detect shutdown

Source

pub fn block_on<F>(&self, future: F) -> F::Output
where F: Future,

Block on a future from a sync context

This is the primary method for bridging sync FFI calls to async handlers.

Source

pub fn spawn<F>(&self, future: F) -> JoinHandle<F::Output>
where F: Future + Send + 'static, F::Output: Send + 'static,

Spawn a task on the runtime

Source

pub fn spawn_blocking<F, R>(&self, func: F) -> JoinHandle<R>
where F: FnOnce() -> R + Send + 'static, R: Send + 'static,

Spawn a blocking task

Source

pub fn shutdown(&self, _timeout: Duration) -> PluginResult<()>

Initiate graceful shutdown

This signals all tasks to stop. The runtime will complete shutdown when dropped. We don’t unconditionally sleep for the timeout since most plugins have no long-running background tasks.

Source

pub fn is_shutting_down(&self) -> bool

Check if shutdown has been triggered

Trait Implementations§

Source§

impl Drop for AsyncRuntime

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: 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, 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