reifydb-sdk 0.4.1

SDK for building ReifyDB operators
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

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

//! Transform traits and types for FFI transform libraries

pub mod exports;
pub mod wrapper;

use std::collections::HashMap;

use reifydb_core::value::column::columns::Columns;
use reifydb_type::value::Value;

use crate::error::Result;

/// Static metadata about a transform type
/// This trait provides compile-time constant metadata
pub trait FFITransformMetadata {
	/// Transform name (must be unique within a library)
	const NAME: &'static str;
	/// API version for FFI compatibility (must match host's CURRENT_API)
	const API: u32;
	/// Semantic version of the transform (e.g., "1.0.0")
	const VERSION: &'static str;
	/// Human-readable description of the transform
	const DESCRIPTION: &'static str;
}

/// Runtime transform behavior
/// Transforms are stateless Columns -> Columns operations
pub trait FFITransform: 'static {
	/// Create a new transform instance with configuration
	fn new(config: &HashMap<String, Value>) -> Result<Self>
	where
		Self: Sized;

	/// Apply the transform to input columns, producing output columns
	fn transform(&mut self, input: Columns) -> Result<Columns>;
}

pub trait FFITransformWithMetadata: FFITransform + FFITransformMetadata {}
impl<T> FFITransformWithMetadata for T where T: FFITransform + FFITransformMetadata {}