futures_intrusive::channel::shared

Struct GenericStateReceiver

Source
pub struct GenericStateReceiver<MutexType, T>
where MutexType: RawMutex, T: Clone + 'static,
{ /* private fields */ }
Expand description

The receiving side of a channel which can be used to exchange values between concurrent tasks.

Tasks can receive values from the channel through the receive method. The returned Future will get resolved when a value is sent into the channel.

Implementations§

Source§

impl<MutexType, T> GenericStateReceiver<MutexType, T>
where MutexType: RawMutex + 'static, T: Clone,

Source

pub fn receive(&self, state_id: StateId) -> StateReceiveFuture<MutexType, T>

Returns a future that gets fulfilled when a value is written to the channel or the channel is closed. state_id specifies the minimum state ID that should be retrieved by the receive operation.

The returned StateReceiveFuture will get fulfilled with the retrieved value as well as the StateId which is required to retrieve the following state

Source

pub fn try_receive(&self, state_id: StateId) -> Option<(StateId, T)>

Attempt to retrieve a value whose StateId is greater than the one provided.

Returns None if no value is found in the channel, or if the current StateId of the value is less or equal to the one provided.

Trait Implementations§

Source§

impl<MutexType, T> Clone for GenericStateReceiver<MutexType, T>
where MutexType: RawMutex, T: Clone,

Source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<MutexType, T> Debug for GenericStateReceiver<MutexType, T>
where MutexType: RawMutex, T: Clone,

Source§

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

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

impl<MutexType, T> Drop for GenericStateReceiver<MutexType, T>
where MutexType: RawMutex, T: Clone,

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<MutexType, T> Freeze for GenericStateReceiver<MutexType, T>

§

impl<MutexType, T> !RefUnwindSafe for GenericStateReceiver<MutexType, T>

§

impl<MutexType, T> Send for GenericStateReceiver<MutexType, T>
where MutexType: Sync + Send, T: Send,

§

impl<MutexType, T> Sync for GenericStateReceiver<MutexType, T>
where MutexType: Sync + Send, T: Send,

§

impl<MutexType, T> Unpin for GenericStateReceiver<MutexType, T>

§

impl<MutexType, T> !UnwindSafe for GenericStateReceiver<MutexType, T>

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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 = 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.