Skip to main content

Runtime

Struct Runtime 

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

A configured Asupersync runtime.

Created via RuntimeBuilder. The runtime owns worker threads and a three-lane priority scheduler. Clone is cheap (shared Arc).

§Example

let runtime = RuntimeBuilder::new().worker_threads(2).build()?;

// Run a future to completion on the current thread.
let result = runtime.block_on(async { 1 + 1 });
assert_eq!(result, 2);

// Spawn from outside async context via a handle.
let handle = runtime.handle().spawn(async { 42u32 });
let value = runtime.block_on(handle);
assert_eq!(value, 42);

Implementations§

Source§

impl Runtime

Source

pub fn with_config(config: RuntimeConfig) -> Result<Self, Error>

Construct a runtime from the given configuration.

Source

pub fn with_config_and_reactor( config: RuntimeConfig, reactor: Option<Arc<dyn Reactor>>, ) -> Result<Self, Error>

Construct a runtime from the given configuration and reactor.

Source

pub fn handle(&self) -> RuntimeHandle

Returns a handle that can spawn tasks from outside the runtime.

Source

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

Run a future to completion on the current thread.

Source

pub fn config(&self) -> &RuntimeConfig

Returns a reference to the runtime configuration.

Source

pub fn is_quiescent(&self) -> bool

Returns true if the runtime is quiescent (no live tasks or I/O).

Source

pub fn spawn_blocking<F>(&self, f: F) -> Option<BlockingTaskHandle>
where F: FnOnce() + Send + 'static,

Spawns a blocking task on the blocking pool.

Returns None if the blocking pool is not configured (max_threads = 0).

§Example
let runtime = RuntimeBuilder::new()
    .blocking_threads(1, 4)
    .build()?;

let handle = runtime.spawn_blocking(|| {
    std::fs::read_to_string("/etc/hosts")
});
Source

pub fn blocking_handle(&self) -> Option<BlockingPoolHandle>

Returns a handle to the blocking pool, if configured.

Trait Implementations§

Source§

impl Clone for Runtime

Source§

fn clone(&self) -> Runtime

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

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