Skip to main content

PollMode

Enum PollMode 

Source
pub enum PollMode {
    Block,
    Spawn,
    Rayon,
    AsyncInline,
    AsyncSpawn,
}
Expand description

WHERE one poll entry’s tick runs — the mandatory word, and the whole of the vocabulary.

§A closed unit enum, and the framework-open law is why rather than an exception

The five words are the 2×2 of WORLD (sync / async) by PLACE (here / elsewhere), plus the one engine that earned a word of its own. What is OPEN is the ENGINE behind each detached word — Spawn and AsyncSpawn are seams a third-party pool implements and a deployment installs — so a new executor costs no word here. That is the same division the store engines keep: the vocabulary is the grammar’s, the implementation is the seam’s.

Variants§

§

Block

block — sync, ON THE DRIVER’S OWN THREAD. The tick’s answer reaches the taps.

§

Spawn

spawn — sync, DETACHED to a thread (the shipped Thread citizen).

§

Rayon

rayon — sync, DETACHED to rayon’s pool (the shipped Rayon citizen, behind the runtime crate’s rayon feature).

§

AsyncInline

async(inline) — AWAITED in the driver’s loop. Today’s behaviour, now said out loud.

§

AsyncSpawn

async(spawn) — DETACHED as a task on whichever AsyncSpawn the deployment installed.

Implementations§

Source§

impl PollMode

Source

pub const ALL: [Self; 5]

Every mode, in the order a refusal offers them — the two INLINE roads first, because they are the ones an entry with no handler may take.

Source

pub const fn as_str(self) -> &'static str

The word a declaration writes, and the word a refusal names.

Source

pub const fn blocking(self) -> bool

Whether the body is SYNC — which decides whether the mount’s bound is Tick or AsyncTick, and which write family a granted store is reached through.

Source

pub const fn detached(self) -> bool

Whether the tick LEAVES the driver — which decides whether the handler and its context are cloned per tick, and whether the seat can answer anything at all.

Source

pub const fn lapses(self) -> bool

Whether the AT-MOST-ONE-IN-FLIGHT default governs it — the sync-detached family, and the only place the concurrent word has a seat.

Trait Implementations§

Source§

impl Clone for PollMode

Source§

fn clone(&self) -> Self

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 Copy for PollMode

Source§

impl Debug for PollMode

Source§

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

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

impl Eq for PollMode

Source§

impl Hash for PollMode

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for PollMode

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PollMode

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