Struct FinishedStream

pub struct FinishedStream { /* private fields */ }

A stream that has yielded all the items it ever will.

The underlying stream will only be dropped by explicitly removing it from the associated StreamUnordered. This method is marked as #[must_use] to ensure that you either remove the stream immediately, or you explicitly ask for it to be kept around for later use.

If the FinishedStream is dropped, the exhausted stream will not be dropped until the owning StreamUnordered is.

Implementations

impl FinishedStream

pub fn remove<S>(self, so: Pin<&mut StreamUnordered<S>>)

Remove the exhausted stream.

See StreamUnordered::remove.

pub fn take<S>(self, so: Pin<&mut StreamUnordered<S>>) -> Option<S>

where S: Unpin,

Take the exhausted stream.

Note that this requires S: Unpin since it moves the stream even though it has already been pinned by StreamUnordered.

See StreamUnordered::take.

pub fn keep(self)

Leave the exhausted stream in the StreamUnordered.

This allows you to continue to access the stream through StreamUnordered::get_mut and friends should you need to perform further operations on it (e.g., if it is also being used as a Sink). Note that the stream will then not be dropped until you explicitly remove or take it from the StreamUnordered.

pub fn token(self) -> usize

Return the token associated with the exhausted stream.