Struct stabby::future::StableWaker

#[repr(C)]
pub struct StableWaker<'a, Alloc = LibcAlloc>
where
    Alloc: IAlloc,
{ /* private fields */ }

An ABI-stable waker.

This is done by wrapping a provided core::task::Waker with calling convention-shims.

While this is the only way to guarantee ABI-stability when interacting with futures, this does add a layer of indirection, and cloning this waker will cause an allocation. To bench the performance cost of this wrapper and decide if you want to risk ABI-unstability on wakers, you may use RUST_FLAGS='--cfg unsafe_wakers="true"', which will turn StableWaker into a newtype of core::task::Waker.

Implementations

impl<'a, Alloc> StableWaker<'a, Alloc>

where Alloc: IAlloc,

pub const fn has_optimal_layout() -> bool

Returns true if the layout for StableWaker is smaller or equal to that Rust would have generated for it.

impl<'a, Alloc> StableWaker<'a, Alloc>

where Alloc: IAlloc + Default,

pub fn with_waker<F, U>(&self, f: F) -> U

where F: FnOnce(&Waker) -> U,

Turns this into a waker whose clone implementation is to clone the underlying waker into a stable Arc.

Trait Implementations

impl<'a, Alloc> From<&'a Waker> for StableWaker<'a, Alloc>

where Alloc: IAlloc + Default,

fn from(value: &'a Waker) -> StableWaker<'a, Alloc>

Converts to this type from the input type.

impl<'a, Alloc> IStable for StableWaker<'a, Alloc>

where Alloc: IAlloc, Struct<FieldPair<FieldPair<StableLike<&'a Waker, &'a ()>, unsafe extern "C" fn(_: StableLike<&'a Waker, &'a ()>) -> SharedStableWaker<Alloc>>, StableLike<unsafe extern "C" fn(_: &Waker), &'a ()>>>: IStable, StableLike<&'a Waker, &'a ()>: IStable, unsafe extern "C" fn(_: StableLike<&'a Waker, &'a ()>) -> SharedStableWaker<Alloc>: IStable, StableLike<unsafe extern "C" fn(_: &Waker), &'a ()>: IStable,

type ForbiddenValues = <Struct<FieldPair<FieldPair<StableLike<&'a Waker, &'a ()>, unsafe extern "C" fn(_: StableLike<&'a Waker, &'a ()>) -> SharedStableWaker<Alloc>>, StableLike<unsafe extern "C" fn(_: &Waker), &'a ()>>> as IStable>::ForbiddenValues

The values that the annotated type cannot occupy.

type UnusedBits = <Struct<FieldPair<FieldPair<StableLike<&'a Waker, &'a ()>, unsafe extern "C" fn(_: StableLike<&'a Waker, &'a ()>) -> SharedStableWaker<Alloc>>, StableLike<unsafe extern "C" fn(_: &Waker), &'a ()>>> as IStable>::UnusedBits

The padding bits in the annotated types

type Size = <Struct<FieldPair<FieldPair<StableLike<&'a Waker, &'a ()>, unsafe extern "C" fn(_: StableLike<&'a Waker, &'a ()>) -> SharedStableWaker<Alloc>>, StableLike<unsafe extern "C" fn(_: &Waker), &'a ()>>> as IStable>::Size

The size of the annotated type in bytes.

type Align = <Struct<FieldPair<FieldPair<StableLike<&'a Waker, &'a ()>, unsafe extern "C" fn(_: StableLike<&'a Waker, &'a ()>) -> SharedStableWaker<Alloc>>, StableLike<unsafe extern "C" fn(_: &Waker), &'a ()>>> as IStable>::Align

The alignment of the annotated type in bytes.

type HasExactlyOneNiche = <Struct<FieldPair<FieldPair<StableLike<&'a Waker, &'a ()>, unsafe extern "C" fn(_: StableLike<&'a Waker, &'a ()>) -> SharedStableWaker<Alloc>>, StableLike<unsafe extern "C" fn(_: &Waker), &'a ()>>> as IStable>::HasExactlyOneNiche

Allows the detection of whether or not core::option::Options are stable:

type ContainsIndirections = <Struct<FieldPair<FieldPair<StableLike<&'a Waker, &'a ()>, unsafe extern "C" fn(_: StableLike<&'a Waker, &'a ()>) -> SharedStableWaker<Alloc>>, StableLike<unsafe extern "C" fn(_: &Waker), &'a ()>>> as IStable>::ContainsIndirections

Whether or not the type contains indirections (pointers, indices in independent data-structures…)

const REPORT: &'static TypeReport = _

A compile-time generated report of the fields of the type, allowing for compatibility inspection.

const ID: u64 = _

A stable (and ideally unique) identifier for the type. Often generated using crate::report::gen_id, but can be manually set.

fn size() -> usize

Returns the size of the type.

fn align() -> usize

Returns the alignment of the type.