Struct futures_intrusive::channel::shared::StateReceiveFuture

source · [−]

pub struct StateReceiveFuture<MutexType, T> { /* private fields */ }

Expand description

A Future that is returned by the receive function on a state broadcast channel. The future gets resolved with Some((state_id, state)) when a value could be received from the channel.

state represents the new state which had been retrieved from the channel.

state_id is the StateId which can be passed as a parameter to receive() in order to fetch the next state from the channel.

If the channels gets closed and no items are still enqueued inside the channel, the future will resolve to None.

Trait Implementations

source

impl<MutexType, T> Debug for StateReceiveFuture<MutexType, T>

source

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

Formats the value using the given formatter. Read more

source

impl<MutexType, T> Drop for StateReceiveFuture<MutexType, T>

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl<MutexType, T> FusedFuture for StateReceiveFuture<MutexType, T>

source

fn is_terminated(&self) -> bool

Returns true if the underlying future should no longer be polled.

source

impl<MutexType, T> Future for StateReceiveFuture<MutexType, T>

type Output = Option<(StateId, T)>

The type of value produced on completion.

source

fn poll(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<(StateId, T)>>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

source

impl<MutexType: Sync, T: Clone + Send> Send for StateReceiveFuture<MutexType, T>

Auto Trait Implementations

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

impl<MutexType, T> !Sync for StateReceiveFuture<MutexType, T>

impl<MutexType, T> !Unpin for StateReceiveFuture<MutexType, T>

impl<MutexType, T> !UnwindSafe for StateReceiveFuture<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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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<F> IntoFuture for F where
F: Future,

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type IntoFuture = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

source

fn into_future(self) -> <F as IntoFuture>::IntoFuture

🔬 This is a nightly-only experimental API. (into_future)

Creates a future from a value. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct futures_intrusive::channel::shared::StateReceiveFuture

Trait Implementations

impl<MutexType, T> Debug for StateReceiveFuture<MutexType, T>

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

impl<MutexType, T> Drop for StateReceiveFuture<MutexType, T>

fn drop(&mut self)

impl<MutexType, T> FusedFuture for StateReceiveFuture<MutexType, T>

fn is_terminated(&self) -> bool

impl<MutexType, T> Future for StateReceiveFuture<MutexType, T>

type Output = Option<(StateId, T)>

fn poll(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<(StateId, T)>>

impl<MutexType: Sync, T: Clone + Send> Send for StateReceiveFuture<MutexType, T>

Auto Trait Implementations

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

impl<MutexType, T> !Sync for StateReceiveFuture<MutexType, T>

impl<MutexType, T> !Unpin for StateReceiveFuture<MutexType, T>

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

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

fn into(self) -> U

impl<F> IntoFuture for F where
F: Future,

type Output = <F as Future>::Output

type IntoFuture = F

fn into_future(self) -> <F as IntoFuture>::IntoFuture

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct futures_intrusive::channel::shared::StateReceiveFuture

Trait Implementations

impl<MutexType, T> Debug for StateReceiveFuture<MutexType, T>

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

impl<MutexType, T> Drop for StateReceiveFuture<MutexType, T>

fn drop(&mut self)

impl<MutexType, T> FusedFuture for StateReceiveFuture<MutexType, T>

fn is_terminated(&self) -> bool

impl<MutexType, T> Future for StateReceiveFuture<MutexType, T>

type Output = Option<(StateId, T)>

fn poll( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<(StateId, T)>>

impl<MutexType: Sync, T: Clone + Send> Send for StateReceiveFuture<MutexType, T>

Auto Trait Implementations

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

impl<MutexType, T> !Sync for StateReceiveFuture<MutexType, T>

impl<MutexType, T> !Unpin for StateReceiveFuture<MutexType, T>

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

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<F> IntoFuture for F where F: Future,

type Output = <F as Future>::Output

type IntoFuture = F

fn into_future(self) -> <F as IntoFuture>::IntoFuture

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

fn poll(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<(StateId, T)>>

impl<T> Any for T where
T: 'static + ?Sized,

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

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

impl<T, U> Into<U> for T where
U: From<T>,

impl<F> IntoFuture for F where
F: Future,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,