ariel_os::delegate

Struct Delegate

pub struct Delegate<T> { /* private fields */ }
Expand description

Delegate or lend an object to another task.

This struct can be used to lend a &mut T to another task on the same executor. The other task can then call a closure on it. After that, the &mut T is returned to the original task.

Under the hood, Delegate leverages [SendCell] to ensure the delegated object stays on the same executor.

Example:

static SOME_VALUE: Delegate<u32> = Delegate::new();

// in some task
async fn foo() {
  let mut my_val = 0u32;
  SOME_VALUE.lend(&mut my_val).await;
  assert_eq!(my_val, 1);
}

// in some other task
async fn bar() {
  SOME_VALUE.with(|val| *val = 1).await;
}

TODO: this is a PoC implementation.

  • takes 24b for each delegate (on arm), which seems too much.
  • doesn’t protect at all against calling lend() or with() multiple times each, breaking safety assumptions. So while the API seems OK, the implementation needs work.

Implementations§

§

impl<T> Delegate<T>

pub const fn new() -> Delegate<T>

Creates a new Delegate.

pub async fn lend<'a, 'b>(&'a self, something: &'b mut T)
where 'b: 'a,

Lends an object.

This blocks until another task called with().

pub async fn with<U>(&self, func: impl FnOnce(&mut T) -> U) -> U

Calls a closure on a lended object.

This blocks until another task called lend(something).

Trait Implementations§

§

impl<T> Default for Delegate<T>
where T: Default,

§

fn default() -> Delegate<T>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for Delegate<T>

§

impl<T> !RefUnwindSafe for Delegate<T>

§

impl<T> Send for Delegate<T>

§

impl<T> Sync for Delegate<T>

§

impl<T> Unpin for Delegate<T>

§

impl<T> UnwindSafe for Delegate<T>
where T: RefUnwindSafe,

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.

§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

impl<T> Identity for T
where T: ?Sized,

§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
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, 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V