Struct kube::runtime::utils::StreamSubscribe

pub struct StreamSubscribe<S>where
    S: Stream,{ /* private fields */ }

Available on crate feature runtime only.

Exposes the StreamSubscribe::subscribe() method which allows additional consumers of events from a stream without consuming the stream itself.

If a subscriber begins to lag behind the stream, it will receive an Error::Lagged error. The subscriber can then decide to abort its task or tolerate the lost events.

If the [Stream] is dropped or ends, any StreamSubscribe::subscribe() streams will also end.

Warning

If the primary [Stream] is not polled, the StreamSubscribe::subscribe() streams will never receive any events.

Implementations

impl<S> StreamSubscribe<S>where S: Stream,

pub fn new(stream: S) -> StreamSubscribe<S>

pub fn subscribe( &self ) -> impl Stream<Item = Result<Arc<<S as Stream>::Item>, Error>>

Subscribe to events from this stream

Trait Implementations

impl<S> Stream for StreamSubscribe<S>where S: Stream,

type Item = Arc<<S as Stream>::Item>

Values yielded by the stream.

fn poll_next( self: Pin<&mut StreamSubscribe<S>>, cx: &mut Context<'_> ) -> Poll<Option<<StreamSubscribe<S> as Stream>::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.

impl<'pin, S> Unpin for StreamSubscribe<S>where S: Stream, __StreamSubscribe<'pin, S>: Unpin,