Skip to main content

Reactor

Struct Reactor 

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

The executor that owns the reactor — the capability a reactor-bound task is spawned through.

Hold one and you may spawn a future that opens a tokio::net socket, waits on tokio::time, or installs a signal handler. The counterpart is spawn_background, which needs no capability because the executor it lands on is process-global — and, for the same reason, has no reactor.

§Where one comes from

Reactor::current mints one from the runtime entered on the calling thread, and returns None rather than panicking when there is none. Everything else receives one: the IOC and the CA/PVA servers and clients capture it once on their own setup path and hand &Reactor down to the tasks they start. BlockingBridge::reactor is the third source, for a blocking thread the runtime is not entered on.

Implementations§

Source§

impl Reactor

Source

pub fn current() -> Option<Self>

The runtime entered on this thread, or None when there is none.

Deliberately not a panicking constructor: the ambient spawn this replaces panicked from inside itself, which is exactly the failure the capability exists to move into the type. A caller that genuinely cannot continue without one writes its own expect, which names the reason and can be found by a census.

Source

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

Spawn a reactor-bound future.

Works from any thread, including one the runtime is not entered on — the handle carries the runtime, where tokio::spawn read a thread-local.

Source

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

Run a blocking closure on the runtime’s blocking pool.

Trait Implementations§

Source§

impl Clone for Reactor

Source§

fn clone(&self) -> Reactor

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 Debug for Reactor

Source§

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

Formats the value using the given formatter. 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: 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> 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.
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