Struct Stream 

pub struct Stream<S>(/* private fields */);

A wrapper around futures::Stream implementing Source trait.

Stream items must implement Message.

Implementations

impl<S> Stream<S>

pub fn new(stream: S) -> Self

Wraps futures::Stream into the source.

pub fn set(&self, stream: S)

Drops the inner stream and uses the provided one instead.

pub fn replace(&self, stream: S) -> Option<S>

where S: Unpin,

Replaces the inner stream with the provided one.

pub fn close(&self) -> bool

Drops the inner stream and stops emitting messages.

Stream::set and Stream::replace can be used after this method.

impl Stream<()>

pub fn generate<G, F>(generator: G) -> Stream<impl Stream<Item = Envelope>>

where G: FnOnce(Yielder) -> F, F: Future<Output = ()>,

Generates a stream from the provided generator.

The generator receives Yielder as an argument and should return a future that will produce messages by using Yielder::emit.

Examples

#[message]
struct SomeMessage(u32);

#[message]
struct AnotherMessage;

let stream = Stream::generate(|mut y| async move {
    y.emit(SomeMessage(42)).await;
    y.emit(AnotherMessage).await;
});

let mut ctx = ctx.with(&stream);