Skip to main content

StreamReclaim

Struct StreamReclaim 

Source
pub struct StreamReclaim;
Expand description

Yield stream’s items annotated with stream Id, and the exhausted stream itself.

Enables Task implementation on any type that implements Stream.

The stream will be polled for items until it is exhausted. Selector will yield all items, attaching stream’s task Id to each. After that, the Selector will yield the exhausted stream.

let (tx, rx) = mpsc::unbounded::<i32>();
let mut selector = Selector::<_, StreamReclaim>::default();
let id = selector.push(rx).id().clone();
tx.unbounded_send(1).unwrap();
match selector.next().await.unwrap() {
    ControlFlow::Continue(item) => {
        assert_eq!(item.0, id);
        assert_eq!(item.1, 1);       
    }
    ControlFlow::Break(..) => unreachable!("channel is still open"),
}
drop(tx);
match selector.next().await.unwrap() {
    ControlFlow::Continue(..) => {
        unreachable!("channel was closed");
    }
    ControlFlow::Break((item)) => {
        let rx: mpsc::UnboundedReceiver<i32> = item.into_inner();
    }
}
assert!(selector.is_empty());

Trait Implementations§

Source§

impl Clone for StreamReclaim

Source§

fn clone(&self) -> StreamReclaim

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 StreamReclaim

Source§

impl Debug for StreamReclaim

Source§

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

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

impl Default for StreamReclaim

Source§

fn default() -> StreamReclaim

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

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<S, T> Task<&mut S> for T
where T: Task<S>, S: ?Sized,

Source§

type Cont = <T as Task<S>>::Cont

Type returned from Self::poll_progress when the task produces some value, but has not finished yet.
Source§

type Break = <T as Task<S>>::Break

Type returned from Self::poll_progress when the task produces its last value.
Source§

type Output = <T as Task<S>>::Output

Source§

fn poll_progress( self: Pin<&mut T>, strategy: &mut &mut S, cx: &mut Context<'_>, ) -> Poll<ControlFlow<<T as Task<&mut S>>::Break, <T as Task<&mut S>>::Cont>>

Polls progress on this task using the given strategy. Read more
Source§

fn transform_cont( task: BorrowedMut<'_, T>, strategy: &mut &mut S, value: <T as Task<&mut S>>::Cont, ) -> Option<<T as Task<&mut S>>::Output>

Transforms Self::Cont value obtained from Self::poll_progress into the final value type Self::Output. Read more
Source§

fn transform_break( task: Removed<T>, strategy: &mut &mut S, value: <T as Task<&mut S>>::Break, ) -> Option<<T as Task<&mut S>>::Output>

Transforms Self::Break value obtained from Self::poll_progress into the final value type Self::Output. Read more
Source§

impl<S, T> Task<Box<S>> for T
where T: Task<S>, S: ?Sized,

Source§

type Cont = <T as Task<S>>::Cont

Type returned from Self::poll_progress when the task produces some value, but has not finished yet.
Source§

type Break = <T as Task<S>>::Break

Type returned from Self::poll_progress when the task produces its last value.
Source§

type Output = <T as Task<S>>::Output

Source§

fn poll_progress( self: Pin<&mut T>, strategy: &mut Box<S>, cx: &mut Context<'_>, ) -> Poll<ControlFlow<<T as Task<Box<S>>>::Break, <T as Task<Box<S>>>::Cont>>

Polls progress on this task using the given strategy. Read more
Source§

fn transform_cont( task: BorrowedMut<'_, T>, strategy: &mut Box<S>, value: <T as Task<Box<S>>>::Cont, ) -> Option<<T as Task<Box<S>>>::Output>

Transforms Self::Cont value obtained from Self::poll_progress into the final value type Self::Output. Read more
Source§

fn transform_break( task: Removed<T>, strategy: &mut Box<S>, value: <T as Task<Box<S>>>::Break, ) -> Option<<T as Task<Box<S>>>::Output>

Transforms Self::Break value obtained from Self::poll_progress into the final value type Self::Output. Read more
Source§

impl<S> Task<StreamReclaim> for S
where S: Stream,

Source§

type Cont = <S as Stream>::Item

Type returned from Self::poll_progress when the task produces some value, but has not finished yet.
Source§

type Break = ()

Type returned from Self::poll_progress when the task produces its last value.
Source§

type Output = ControlFlow<Removed<S>, (Id<S>, <S as Stream>::Item)>

Source§

fn poll_progress( self: Pin<&mut S>, _: &mut StreamReclaim, cx: &mut Context<'_>, ) -> Poll<ControlFlow<<S as Task<StreamReclaim>>::Break, <S as Task<StreamReclaim>>::Cont>>

Polls progress on this task using the given strategy. Read more
Source§

fn transform_cont( task: BorrowedMut<'_, S>, _: &mut StreamReclaim, value: <S as Task<StreamReclaim>>::Cont, ) -> Option<<S as Task<StreamReclaim>>::Output>

Transforms Self::Cont value obtained from Self::poll_progress into the final value type Self::Output. Read more
Source§

fn transform_break( task: Removed<S>, _: &mut StreamReclaim, _: <S as Task<StreamReclaim>>::Break, ) -> Option<<S as Task<StreamReclaim>>::Output>

Transforms Self::Break value obtained from Self::poll_progress into the final value type Self::Output. Read more
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.