vortex-array 0.14.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

use std::fmt::Debug;

use vortex_error::{vortex_bail, VortexResult};

use crate::encoding::{ArrayEncoding, EncodingId};
use crate::{Array, ArrayTrait, Canonical};

/// An encoding of an array that we cannot interpret.
///
/// Vortex allows for pluggable encodings. This can lead to issues when one process produces a file
/// using a custom encoding, and then another process without knowledge of the encoding attempts
/// to read it.
///
/// `OpaqueEncoding` allows deserializing these arrays. Many common operations will fail, but it
/// allows deserialization and introspection in a type-erased manner on the children and metadata.
///
/// We hold the original 16-bit encoding ID for producing helpful error messages.
#[derive(Debug, Clone, Copy)]
pub struct OpaqueEncoding(pub u16);

impl ArrayEncoding for OpaqueEncoding {
    fn id(&self) -> EncodingId {
        EncodingId::new("vortex.opaque", self.0)
    }

    fn canonicalize(&self, _array: Array) -> VortexResult<Canonical> {
        vortex_bail!(
            "OpaqueArray: canonicalize cannot be called for opaque array ({})",
            self.0
        );
    }

    fn with_dyn(
        &self,
        _array: &Array,
        _f: &mut dyn for<'b> FnMut(&'b (dyn ArrayTrait + 'b)) -> VortexResult<()>,
    ) -> VortexResult<()> {
        vortex_bail!(
            "OpaqueEncoding: with_dyn cannot be called for opaque array ({})",
            self.0
        )
    }
}