Struct Stream

pub struct Stream<T: Clone + Send> { /* private fields */ }

Streams allow for streaming values from source to sink.

A Stream implements both a reader (which implements the Stream trait), and a writer (which can be sent to another thread). As new values are written, any pending readers will be woken up to receive the new value.

Implementations

impl<T: Clone + Send> Stream<T>

pub fn new_closed(pulled: Vec<T>) -> Self

Constructs a new Stream, and immediately closes it with only the passed values.

pub fn new_open( pulled: Vec<T>, source: Box<dyn StreamTrait<Item = T> + Send + 'static>, ) -> Self

Creates a new Stream, which will lazily pull from the source stream.

pub fn read(&self) -> StreamRead<T>

Returns a [StreamTrait] implementation to poll values out of our Stream.

pub async fn into_single(&self) -> SingleValue<T>

impl<T: Clone + Send, E: Clone + Send> Stream<Result<T, E>>

pub async fn try_into_single(&self) -> Result<SingleValue<T>, E>

Converts a TryStream into a single value when possible.

Trait Implementations

impl<T: Clone + Clone + Send> Clone for Stream<T>

fn clone(&self) -> Stream<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Clone + Send> Debug for Stream<T>

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

Formats the value using the given formatter.

impl<T: Clone + Send> Default for Stream<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: Clone + Send + Deserialize<'de>> Deserialize<'de> for Stream<T>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<T: Clone + Send, S: StreamTrait<Item = T> + Send + Unpin + 'static> From<S> for Stream<T>

fn from(source: S) -> Self

Converts to this type from the input type.

impl<T: Clone + PartialEq + Send> PartialEq for Stream<T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Clone + Serialize + Send> Serialize for Stream<T>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<T: Clone + Eq + Send> Eq for Stream<T>