Skip to main content

TumblingWindowOperator

Struct TumblingWindowOperator 

Source
pub struct TumblingWindowOperator<A: Aggregator> { /* private fields */ }
Expand description

Tumbling window operator.

Processes events through non-overlapping, fixed-size time windows. Events are assigned to windows based on their timestamps, aggregated, and results are emitted based on the configured EmitStrategy.

§Emit Strategies

  • OnWatermark (default): Emit when watermark passes window end
  • Periodic: Emit intermediate results at intervals, final on watermark
  • OnUpdate: Emit after every state update

§Late Data Handling

Events that arrive after window_end + allowed_lateness are considered late. Their behavior is controlled by LateDataConfig:

  • Drop the event (default)
  • Route to a named side output for separate processing

§State Management

Window state is stored in the operator context’s state store using prefixed keys:

  • win:<window_id> - Accumulator state
  • meta:<window_id> - Window metadata (registration status, etc.)

§Watermark Triggering

Windows are triggered when the watermark advances past window_end + allowed_lateness. This ensures late data within the grace period is still processed.

Implementations§

Source§

impl<A: Aggregator> TumblingWindowOperator<A>

Source

pub fn new( assigner: TumblingWindowAssigner, aggregator: A, allowed_lateness: Duration, ) -> Self

Creates a new tumbling window operator.

§Arguments
  • assigner - Window assigner for determining window boundaries
  • aggregator - Aggregation function to apply within windows
  • allowed_lateness - Grace period for late data after window close
§Panics

Panics if allowed lateness does not fit in i64.

Source

pub fn with_id( assigner: TumblingWindowAssigner, aggregator: A, allowed_lateness: Duration, operator_id: String, ) -> Self

Creates a new tumbling window operator with a custom operator ID.

§Panics

Panics if allowed lateness does not fit in i64.

Source

pub fn set_emit_strategy(&mut self, strategy: EmitStrategy)

Sets the emit strategy for this window operator.

§Arguments
  • strategy - The emit strategy to use
§Example
use laminar_core::operator::window::{
    TumblingWindowAssigner, TumblingWindowOperator, CountAggregator, EmitStrategy,
};
use std::time::Duration;

let assigner = TumblingWindowAssigner::new(Duration::from_secs(60));
let mut operator = TumblingWindowOperator::new(
    assigner,
    CountAggregator::new(),
    Duration::from_secs(5),
);

// Emit every 10 seconds instead of waiting for watermark
operator.set_emit_strategy(EmitStrategy::Periodic(Duration::from_secs(10)));
Source

pub fn emit_strategy(&self) -> &EmitStrategy

Returns the current emit strategy.

Source

pub fn set_late_data_config(&mut self, config: LateDataConfig)

Sets the late data handling configuration.

§Arguments
  • config - The late data configuration to use
§Example
use laminar_core::operator::window::{
    TumblingWindowAssigner, TumblingWindowOperator, CountAggregator, LateDataConfig,
};
use std::time::Duration;

let assigner = TumblingWindowAssigner::new(Duration::from_secs(60));
let mut operator = TumblingWindowOperator::new(
    assigner,
    CountAggregator::new(),
    Duration::from_secs(5),
);

// Route late events to a side output
operator.set_late_data_config(LateDataConfig::with_side_output("late_events".to_string()));
Source

pub fn late_data_config(&self) -> &LateDataConfig

Returns the current late data configuration.

Source

pub fn late_data_metrics(&self) -> &LateDataMetrics

Returns the late data metrics.

Use this to monitor late data behavior and set up alerts.

Source

pub fn reset_late_data_metrics(&mut self)

Resets the late data metrics counters.

Source

pub fn assigner(&self) -> &TumblingWindowAssigner

Returns the window assigner.

Source

pub fn allowed_lateness_ms(&self) -> i64

Returns the allowed lateness in milliseconds.

Trait Implementations§

Source§

impl<A: Aggregator> Operator for TumblingWindowOperator<A>

Source§

fn process(&mut self, event: &Event, ctx: &mut OperatorContext<'_>) -> OutputVec

Process an incoming event
Source§

fn on_timer(&mut self, timer: Timer, ctx: &mut OperatorContext<'_>) -> OutputVec

Handle timer expiration
Source§

fn checkpoint(&self) -> OperatorState

Checkpoint the operator’s state
Source§

fn restore(&mut self, state: OperatorState) -> Result<(), OperatorError>

Restore from a checkpoint Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,