reifydb-sdk 0.4.13

SDK for building ReifyDB operators, procedures, transforms and more
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2025 ReifyDB

use reifydb_core::encoded::{key::EncodedKey, row::EncodedRow, shape::RowShape};

use super::{FFIRawStatefulOperator, utils};
use crate::{error::Result, operator::context::OperatorContext};

/// Window-based state management for time or count-based windowing
///
/// This trait provides support for operators that partition state into windows,
/// such as sliding time windows or tumbling count windows. Each window has its own
/// state entry indexed by a window key.
///
/// Window keys should be designed to support efficient expiration. Common patterns:
/// - Time-based: Use timestamp as part of the key
/// - Count-based: Use sequence number as part of the key
/// - Composite: Combine time/count with other dimensions
pub trait FFIWindowStateful: FFIRawStatefulOperator {
	fn shape(&self) -> RowShape;

	fn create_state(&self) -> EncodedRow {
		let shape = self.shape();
		shape.allocate()
	}

	fn load_state(&self, ctx: &mut OperatorContext, window_key: &EncodedKey) -> Result<EncodedRow> {
		utils::load_or_create_row(ctx, window_key, &self.shape())
	}

	fn save_state(&self, ctx: &mut OperatorContext, window_key: &EncodedKey, row: &EncodedRow) -> Result<()> {
		utils::save_row(ctx, window_key, row)
	}

	fn remove_window(&self, ctx: &mut OperatorContext, window_key: &EncodedKey) -> Result<()> {
		self.state_remove(ctx, window_key)
	}

	fn update_window<F>(&self, ctx: &mut OperatorContext, window_key: &EncodedKey, f: F) -> Result<EncodedRow>
	where
		F: FnOnce(&RowShape, &mut EncodedRow) -> Result<()>,
	{
		let shape = self.shape();
		let mut row = self.load_state(ctx, window_key)?;
		f(&shape, &mut row)?;
		self.save_state(ctx, window_key, &row)?;
		Ok(row)
	}
}