Struct StreamCore

pub struct StreamCore<S: Scope, C> { /* private fields */ }

Abstraction of a stream of C: Container records timestamped with S::Timestamp.

Internally Stream maintains a list of data recipients who should be presented with data produced by the source of the stream.

Implementations

impl<S: Scope, C> StreamCore<S, C>

pub fn connect_to<P: Push<Message<S::Timestamp, C>> + 'static>( &self, target: Target, pusher: P, identifier: usize, )

Connects the stream to a destination.

The destination is described both by a Target, for progress tracking information, and a P: Push where the records should actually be sent. The identifier is unique to the edge and is used only for logging purposes.

pub fn new(source: Source, output: TeeHelper<S::Timestamp, C>, scope: S) -> Self

Allocates a Stream from a supplied Source name and rendezvous point.

pub fn name(&self) -> &Source

The name of the stream’s source operator.

pub fn scope(&self) -> S

The scope immediately containing the stream.

pub fn container<C2>(self) -> StreamCore<S, C2>

where Self: AsStream<S, C2>,

Allows the assertion of a container type, for the benefit of type inference.

Trait Implementations

impl<S: Scope, C> AsStream<S, C> for StreamCore<S, C>

fn as_stream(self) -> Self

Translate self to a StreamCore.

impl<S: Scope, C: Container> BranchWhen<<S as ScopeParent>::Timestamp> for StreamCore<S, C>

fn branch_when( &self, condition: impl Fn(&S::Timestamp) -> bool + 'static, ) -> (Self, Self)

Takes one input stream and splits it into two output streams. For each time, the supplied closure is called. If it returns true, the records for that will be sent to the second returned stream, otherwise they will be sent to the first.

impl<S: Scope, C: Container> Capture<<S as ScopeParent>::Timestamp, C> for StreamCore<S, C>

fn capture_into<P: EventPusher<S::Timestamp, C> + 'static>( &self, event_pusher: P, )

Captures a stream of timestamped data for later replay.

fn capture(&self) -> Receiver<Event<T, C>>

Captures a stream using Rust’s MPSC channels.

impl<S: Scope, C> Clone for StreamCore<S, C>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<G: Scope, C: Container> Concat<G, C> for StreamCore<G, C>

fn concat(&self, other: &StreamCore<G, C>) -> StreamCore<G, C>

Merge the contents of two streams.

impl<G: Scope, C: Container> Concatenate<G, C> for StreamCore<G, C>

fn concatenate<I>(&self, sources: I) -> StreamCore<G, C>

where I: IntoIterator<Item = StreamCore<G, C>>,

Merge the contents of multiple streams.

impl<G: Scope, C: Container> ConnectLoop<G, C> for StreamCore<G, C>

fn connect_loop(&self, handle: Handle<G, C>)

Connect a Stream to be the input of a loop variable.

impl<S, C> Debug for StreamCore<S, C>

where S: Scope,

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

Formats the value using the given formatter.

impl<G: Scope, T: Timestamp + Refines<G::Timestamp>, C: Container> Enter<G, T, C> for StreamCore<G, C>

fn enter<'a>(&self, scope: &Child<'a, G, T>) -> StreamCore<Child<'a, G, T>, C>

Moves the Stream argument into a child of its current Scope.

impl<G: Scope, C> Exchange<C> for StreamCore<G, C>

where C: Container + SizableContainer + DrainContainer + Send + ContainerBytes + for<'a> PushInto<C::Item<'a>>,

fn exchange<F>(&self, route: F) -> StreamCore<G, C>

where for<'a> F: FnMut(&C::Item<'a>) -> u64 + 'static,

Exchange records between workers.

impl<G: Scope, C> Filter<C> for StreamCore<G, C>

where for<'a> C: PushInto<C::Item<'a>> + Container + SizableContainer + DrainContainer,

fn filter<P: FnMut(&C::Item<'_>) -> bool + 'static>( &self, predicate: P, ) -> StreamCore<G, C>

Returns a new instance of self containing only records satisfying predicate.

impl<G: Scope, C: Container + IterContainer> Inspect<G, C> for StreamCore<G, C>

fn inspect_core<F>(&self, func: F) -> Self

where F: FnMut(Result<(&G::Timestamp, &C), &[G::Timestamp]>) + 'static,

Runs a supplied closure on each observed data batch, and each frontier advancement.

fn inspect<F>(&self, func: F) -> Self

where F: for<'a> FnMut(C::ItemRef<'a>) + 'static,

Runs a supplied closure on each observed data element.

fn inspect_time<F>(&self, func: F) -> Self

where F: for<'a> FnMut(&G::Timestamp, C::ItemRef<'a>) + 'static,

Runs a supplied closure on each observed data element and associated time.

fn inspect_batch(&self, func: impl FnMut(&G::Timestamp, &C) + 'static) -> Self

Runs a supplied closure on each observed data batch (time and data slice).

impl<G: Scope, C: Container> InspectCore<G, C> for StreamCore<G, C>

fn inspect_container<F>(&self, func: F) -> StreamCore<G, C>

where F: FnMut(Result<(&G::Timestamp, &C), &[G::Timestamp]>) + 'static,

Runs a supplied closure on each observed container, and each frontier advancement.

impl<G: Scope, C: Container, T: Timestamp + Refines<G::Timestamp>> Leave<G, C> for StreamCore<Child<'_, G, T>, C>

fn leave(&self) -> StreamCore<G, C>

Moves a Stream to the parent of its current Scope.

impl<S: Scope, C: Container + DrainContainer> Map<S, C> for StreamCore<S, C>

fn flat_map<C2, I, L>(&self, logic: L) -> StreamCore<S, C2>

where I: IntoIterator, C2: Container + SizableContainer + PushInto<I::Item>, L: FnMut(C::Item<'_>) -> I + 'static,

Consumes each element of the stream and yields some number of new elements.

fn map<C2, D2, L>(&self, logic: L) -> StreamCore<S, C2>

where C2: Container + SizableContainer + PushInto<D2>, L: FnMut(C::Item<'_>) -> D2 + 'static,

Consumes each element of the stream and yields a new element.

fn flat_map_builder<'t, I, L>( &'t self, logic: L, ) -> FlatMapBuilder<'t, Self, C, L, I>

where C: Clone + 'static, L: for<'a> Fn(C::Item<'a>) -> I, Self: Sized,

Creates a FlatMapBuilder, which allows chaining of iterator logic before finalization into a stream.

impl<S: Scope, C: Container + DrainContainer> OkErr<S, C> for StreamCore<S, C>

fn ok_err<C1, D1, C2, D2, L>( &self, logic: L, ) -> (StreamCore<S, C1>, StreamCore<S, C2>)

where C1: Container + SizableContainer + PushInto<D1>, C2: Container + SizableContainer + PushInto<D2>, L: FnMut(C::Item<'_>) -> Result<D1, D2> + 'static,

Takes one input stream and splits it into two output streams. For each record, the supplied closure is called with the data. If it returns Ok(x), then x will be sent to the first returned stream; otherwise, if it returns Err(e), then e will be sent to the second.

impl<G: Scope, C1: Container> Operator<G, C1> for StreamCore<G, C1>

fn unary_frontier<CB, B, L, P>( &self, pact: P, name: &str, constructor: B, ) -> StreamCore<G, CB::Container>

where CB: ContainerBuilder, B: FnOnce(Capability<G::Timestamp>, OperatorInfo) -> L, L: FnMut(&mut FrontieredInputHandleCore<'_, G::Timestamp, C1, P::Puller>, &mut OutputHandleCore<'_, G::Timestamp, CB, Tee<G::Timestamp, CB::Container>>) + 'static, P: ParallelizationContract<G::Timestamp, C1>,

Creates a new dataflow operator that partitions its input stream by a parallelization strategy pact, and repeatedly invokes logic, the function returned by the function passed as constructor. logic can read from the input stream, write to the output stream, and inspect the frontier at the input.

fn unary_notify<CB: ContainerBuilder, L: FnMut(&mut InputHandleCore<G::Timestamp, C1, P::Puller>, &mut OutputHandleCore<'_, G::Timestamp, CB, Tee<G::Timestamp, CB::Container>>, &mut Notificator<'_, G::Timestamp>) + 'static, P: ParallelizationContract<G::Timestamp, C1>>( &self, pact: P, name: &str, init: impl IntoIterator<Item = G::Timestamp>, logic: L, ) -> StreamCore<G, CB::Container>

Creates a new dataflow operator that partitions its input stream by a parallelization strategy pact, and repeatedly invokes logic, the function returned by the function passed as constructor. logic can read from the input stream, write to the output stream, and inspect the frontier at the input.

fn unary<CB, B, L, P>( &self, pact: P, name: &str, constructor: B, ) -> StreamCore<G, CB::Container>

where CB: ContainerBuilder, B: FnOnce(Capability<G::Timestamp>, OperatorInfo) -> L, L: FnMut(&mut InputHandleCore<G::Timestamp, C1, P::Puller>, &mut OutputHandleCore<'_, G::Timestamp, CB, Tee<G::Timestamp, CB::Container>>) + 'static, P: ParallelizationContract<G::Timestamp, C1>,

Creates a new dataflow operator that partitions its input stream by a parallelization strategy pact, and repeatedly invokes logic, the function returned by the function passed as constructor. logic can read from the input stream, and write to the output stream.

fn binary_frontier<C2, CB, B, L, P1, P2>( &self, other: &StreamCore<G, C2>, pact1: P1, pact2: P2, name: &str, constructor: B, ) -> StreamCore<G, CB::Container>

where C2: Container, CB: ContainerBuilder, B: FnOnce(Capability<G::Timestamp>, OperatorInfo) -> L, L: FnMut(&mut FrontieredInputHandleCore<'_, G::Timestamp, C1, P1::Puller>, &mut FrontieredInputHandleCore<'_, G::Timestamp, C2, P2::Puller>, &mut OutputHandleCore<'_, G::Timestamp, CB, Tee<G::Timestamp, CB::Container>>) + 'static, P1: ParallelizationContract<G::Timestamp, C1>, P2: ParallelizationContract<G::Timestamp, C2>,

Creates a new dataflow operator that partitions its input streams by a parallelization strategy pact, and repeatedly invokes logic, the function returned by the function passed as constructor. logic can read from the input streams, write to the output stream, and inspect the frontier at the inputs.

fn binary_notify<C2: Container, CB: ContainerBuilder, L: FnMut(&mut InputHandleCore<G::Timestamp, C1, P1::Puller>, &mut InputHandleCore<G::Timestamp, C2, P2::Puller>, &mut OutputHandleCore<'_, G::Timestamp, CB, Tee<G::Timestamp, CB::Container>>, &mut Notificator<'_, G::Timestamp>) + 'static, P1: ParallelizationContract<G::Timestamp, C1>, P2: ParallelizationContract<G::Timestamp, C2>>( &self, other: &StreamCore<G, C2>, pact1: P1, pact2: P2, name: &str, init: impl IntoIterator<Item = G::Timestamp>, logic: L, ) -> StreamCore<G, CB::Container>

Creates a new dataflow operator that partitions its input streams by a parallelization strategy pact, and repeatedly invokes logic, the function returned by the function passed as constructor. logic can read from the input streams, write to the output stream, and inspect the frontier at the inputs.

fn binary<C2, CB, B, L, P1, P2>( &self, other: &StreamCore<G, C2>, pact1: P1, pact2: P2, name: &str, constructor: B, ) -> StreamCore<G, CB::Container>

where C2: Container, CB: ContainerBuilder, B: FnOnce(Capability<G::Timestamp>, OperatorInfo) -> L, L: FnMut(&mut InputHandleCore<G::Timestamp, C1, P1::Puller>, &mut InputHandleCore<G::Timestamp, C2, P2::Puller>, &mut OutputHandleCore<'_, G::Timestamp, CB, Tee<G::Timestamp, CB::Container>>) + 'static, P1: ParallelizationContract<G::Timestamp, C1>, P2: ParallelizationContract<G::Timestamp, C2>,

Creates a new dataflow operator that partitions its input streams by a parallelization strategy pact, and repeatedly invokes logic, the function returned by the function passed as constructor. logic can read from the input streams, write to the output stream, and inspect the frontier at the inputs.

fn sink<L, P>(&self, pact: P, name: &str, logic: L)

where L: FnMut(&mut FrontieredInputHandleCore<'_, G::Timestamp, C1, P::Puller>) + 'static, P: ParallelizationContract<G::Timestamp, C1>,

Creates a new dataflow operator that partitions its input stream by a parallelization strategy pact, and repeatedly invokes the function logic which can read from the input stream and inspect the frontier at the input.

impl<G: Scope, C: Container + DrainContainer> Partition<G, C> for StreamCore<G, C>

fn partition<CB, D2, F>( &self, parts: u64, route: F, ) -> Vec<StreamCore<G, CB::Container>>

where CB: ContainerBuilder + PushInto<D2>, F: FnMut(C::Item<'_>) -> (u64, D2) + 'static,

Produces parts output streams, containing records produced and assigned by route.

impl<G: Scope, C: Container> Probe<G, C> for StreamCore<G, C>

fn probe(&self) -> Handle<G::Timestamp>

Constructs a progress probe which indicates which timestamps have elapsed at the operator.

fn probe_with(&self, handle: &Handle<G::Timestamp>) -> StreamCore<G, C>

Inserts a progress probe in a stream.

impl<S: Scope, C: Container> Reclock<S> for StreamCore<S, C>

fn reclock<TC: Container>(&self, clock: &StreamCore<S, TC>) -> StreamCore<S, C>

Delays records until an input is observed on the clock input.

impl<S: Scope, C: Container> SharedStream<S, C> for StreamCore<S, C>

fn shared(&self) -> StreamCore<S, Rc<C>>

Convert a stream into a stream of shared data