Struct PeriodicGenerator 

pub struct PeriodicGenerator<G: WatermarkGenerator> { /* private fields */ }

Periodic watermark generator that emits at fixed wall-clock intervals.

Wraps another generator and emits watermarks periodically even when no events are arriving. Useful for handling idle sources and ensuring time-based windows eventually trigger.

Example

use laminar_core::time::{
    PeriodicGenerator, BoundedOutOfOrdernessGenerator, WatermarkGenerator,
};
use std::time::Duration;

let inner = BoundedOutOfOrdernessGenerator::new(100);
let mut gen = PeriodicGenerator::new(inner, Duration::from_millis(500));

// First event
gen.on_event(1000);

// Later, periodic check may emit watermark
// (depends on wall-clock time elapsed)
let wm = gen.on_periodic();

Implementations

impl<G: WatermarkGenerator> PeriodicGenerator<G>

pub fn new(inner: G, period: Duration) -> Self

Creates a new periodic generator wrapping another generator.

Arguments

• inner - The underlying watermark generator
• period - How often to emit watermarks (wall-clock time)

pub fn inner(&self) -> &G

Returns a reference to the inner generator.

pub fn inner_mut(&mut self) -> &mut G

Returns a mutable reference to the inner generator.

Trait Implementations

impl<G: WatermarkGenerator> WatermarkGenerator for PeriodicGenerator<G>

fn on_event(&mut self, timestamp: i64) -> Option<Watermark>

Process an event timestamp and potentially emit a new watermark.

fn on_periodic(&mut self) -> Option<Watermark>

Called periodically to emit watermarks based on wall-clock time.

fn current_watermark(&self) -> i64

Returns the current watermark value without advancing it.