Struct sodium_rust::StreamSink

pub struct StreamSink<A> {
    pub impl_: StreamSinkImpl<A>,
}

A Stream that allows values to be pushed into it, acting as an interface between the world of I/O and the world of FRP.

Note: This should only be used from outside the context of

the Sodium system to inject data from I/O into the reactive system.

Fields

impl_: StreamSinkImpl<A>

Implementations

impl<A: Clone + Send + 'static> StreamSink<A>

pub fn new(sodium_ctx: &SodiumCtx) -> StreamSink<A>

Create a StreamSink that allows calling send on it once per transaction.

If you call send more than once in a transaction on a StreamSink constructed with StreamSink::new it will panic. If you need to do this then use StreamSink::new_with_coalescer.

pub fn new_with_coalescer<COALESCER: FnMut(&A, &A) -> A + Send + 'static>(
    sodium_ctx: &SodiumCtx,
    coalescer: COALESCER
) -> StreamSink<A>

Create a StreamSink that allows calling send one or more times per transaction.

If you call send on the returned StreamSink more than once in a single transaction the events will be combined into a single event using the specified combining function. The combining function should be associative.

pub fn stream(&self) -> Stream<A>

Return a Stream that can be used in the creation of Sodium logic that will consume events pushed into this StreamSink from the I/O world.

pub fn send(&self, a: A)

Send a value to be made available to consumers of the Stream associated with this StreamSink.

This method may not be called in handlers registered with Stream::listen or Cell::listen.

Trait Implementations

impl<A> Clone for StreamSink<A>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.