vortex-array 0.59.4

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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

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

use vortex_session::Ref;
use vortex_session::SessionExt;
use vortex_session::registry::Registry;

use crate::arrays::BoolVTable;
use crate::arrays::ChunkedVTable;
use crate::arrays::ConstantVTable;
use crate::arrays::DecimalVTable;
use crate::arrays::ExtensionVTable;
use crate::arrays::FixedSizeListVTable;
use crate::arrays::ListVTable;
use crate::arrays::ListViewVTable;
use crate::arrays::MaskedVTable;
use crate::arrays::NullVTable;
use crate::arrays::PrimitiveVTable;
use crate::arrays::StructVTable;
use crate::arrays::VarBinVTable;
use crate::arrays::VarBinViewVTable;
use crate::vtable::ArrayId;
use crate::vtable::DynVTable;

pub type ArrayRegistry = Registry<&'static dyn DynVTable>;

#[derive(Debug)]
pub struct ArraySession {
    /// The set of registered array encodings.
    registry: ArrayRegistry,
}

impl ArraySession {
    pub fn registry(&self) -> &ArrayRegistry {
        &self.registry
    }

    /// Register a new array encoding, replacing any existing encoding with the same ID.
    pub fn register(&self, id: impl Into<ArrayId>, encoding: impl Into<&'static dyn DynVTable>) {
        self.registry.register(id.into(), encoding.into())
    }
}

impl Default for ArraySession {
    fn default() -> Self {
        let encodings = ArrayRegistry::default();

        // Register the canonical encodings.
        encodings.register(NullVTable::ID, NullVTable);
        encodings.register(BoolVTable::ID, BoolVTable);
        encodings.register(PrimitiveVTable::ID, PrimitiveVTable);
        encodings.register(DecimalVTable::ID, DecimalVTable);
        encodings.register(VarBinViewVTable::ID, VarBinViewVTable);
        encodings.register(ListViewVTable::ID, ListViewVTable);
        encodings.register(FixedSizeListVTable::ID, FixedSizeListVTable);
        encodings.register(StructVTable::ID, StructVTable);
        encodings.register(ExtensionVTable::ID, ExtensionVTable);

        // Register the utility encodings.
        encodings.register(ChunkedVTable::ID, ChunkedVTable);
        encodings.register(ConstantVTable::ID, ConstantVTable);
        encodings.register(MaskedVTable::ID, MaskedVTable);
        encodings.register(ListVTable::ID, ListVTable);
        encodings.register(VarBinVTable::ID, VarBinVTable);

        Self {
            registry: encodings,
        }
    }
}

/// Session data for Vortex arrays.
pub trait ArraySessionExt: SessionExt {
    /// Returns the array encoding registry.
    fn arrays(&self) -> Ref<'_, ArraySession> {
        self.get::<ArraySession>()
    }
}

impl<S: SessionExt> ArraySessionExt for S {}