Struct CloneStream 

pub struct CloneStream<BaseStream>
where
    BaseStream: Stream<Item: Clone>,
{
    pub id: usize,
    /* private fields */
}

A stream that implements Clone and returns cloned items from a base stream.

This is the main type provided by this crate. It wraps any Stream whose items implement Clone, allowing the stream itself to be cloned. Each clone operates independently but shares the same underlying stream data.

Examples

use clone_stream::ForkStream;
use futures::{StreamExt, stream};

let stream = stream::iter(vec![1, 2, 3]);
let clone_stream = stream.fork();

// Create multiple clones that can be used independently
let mut clone1 = clone_stream.clone();
let mut clone2 = clone_stream.clone();

// Each clone can be polled independently
let item1 = clone1.next().await;
let item2 = clone2.next().await;

println!("Clone1 got: {:?}, Clone2 got: {:?}", item1, item2);

Performance

Items are cached internally until all clones have consumed them. The memory usage grows with the number of items that haven’t been consumed by all clones yet.

Fields

id: usize

Unique identifier for this clone within the fork

Implementations

impl<BaseStream> CloneStream<BaseStream>

where BaseStream: Stream<Item: Clone>,

pub fn n_queued_items(&self) -> usize

Returns the number of items currently queued for this clone.

This represents items that have been produced by the base stream but not yet consumed by this particular clone. Other clones may have different queue lengths depending on their consumption patterns.

Panics

Panics if the internal fork lock is poisoned. This should not happen under normal circumstances.

Examples

use clone_stream::ForkStream;
use futures::stream;

let stream = stream::iter(vec![1, 2, 3]);
let clone_stream = stream.fork();
assert_eq!(clone_stream.n_queued_items(), 0);

Trait Implementations

impl<BaseStream> Clone for CloneStream<BaseStream>

where BaseStream: Stream<Item: Clone>,

fn clone(&self) -> Self

Creates a new clone of this stream.

Panics

Panics if the maximum number of clones has been exceeded for this stream. The limit is set when creating the stream with ForkStream::fork_with_limits.

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

Performs copy-assignment from source.

impl<BaseStream> Drop for CloneStream<BaseStream>

where BaseStream: Stream<Item: Clone>,

fn drop(&mut self)

Executes the destructor for this type.

impl<BaseStream> From<BaseStream> for CloneStream<BaseStream>

where BaseStream: Stream<Item: Clone>,

fn from(base_stream: BaseStream) -> CloneStream<BaseStream>

Converts a stream into a cloneable stream.

impl<BaseStream> FusedStream for CloneStream<BaseStream>

where BaseStream: FusedStream<Item: Clone>,

fn is_terminated(&self) -> bool

Returns true if the stream is terminated.

A clone stream is considered terminated when both:

1. The underlying base stream is terminated
2. This clone has no remaining queued items to consume

impl<BaseStream> Stream for CloneStream<BaseStream>

where BaseStream: Stream<Item: Clone>,

type Item = <BaseStream as Stream>::Item

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, current_task: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.