vortex-array 0.68.0

Vortex in memory columnar data format
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

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors

use std::fmt::Debug;
use std::sync::Arc;

use vortex_error::VortexResult;
use vortex_session::VortexSession;

use crate::scalar_fn::ScalarFn;
use crate::scalar_fn::ScalarFnId;
use crate::scalar_fn::ScalarFnRef;
use crate::scalar_fn::ScalarFnVTable;

/// Reference-counted pointer to a scalar function plugin.
pub type ScalarFnPluginRef = Arc<dyn ScalarFnPlugin>;

/// Registry trait for ID-based deserialization of scalar functions.
///
/// Plugins are registered in the session by their [`ScalarFnId`]. When a serialized scalar
/// function is encountered, the session resolves the ID to the plugin and calls [`deserialize`]
/// to reconstruct the value as a [`ScalarFnRef`].
///
/// [`deserialize`]: ScalarFnPlugin::deserialize
pub trait ScalarFnPlugin: 'static + Send + Sync {
    /// Returns the ID for this scalar function.
    fn id(&self) -> ScalarFnId;

    /// Deserialize a scalar function from serialized metadata.
    fn deserialize(&self, metadata: &[u8], session: &VortexSession) -> VortexResult<ScalarFnRef>;
}

impl Debug for dyn ScalarFnPlugin {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_tuple("ScalarFnPlugin").field(&self.id()).finish()
    }
}

impl<V: ScalarFnVTable> ScalarFnPlugin for V {
    fn id(&self) -> ScalarFnId {
        ScalarFnVTable::id(self)
    }

    fn deserialize(&self, metadata: &[u8], session: &VortexSession) -> VortexResult<ScalarFnRef> {
        let options = ScalarFnVTable::deserialize(self, metadata, session)?;
        Ok(ScalarFn::new(self.clone(), options).erased())
    }
}