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

use vortex_error::{VortexError, VortexExpect, VortexResult};

use crate::encoding::Encoding;
use crate::Array;

/// A trait implemented by encodings to verify an opaque [`Array`].
///
/// The caller will already have verified that the encoding ID matches, but the implementor must
/// verify the following:
/// * The metadata is valid (for example, flatbuffer validation to allow unchecked access later).
/// * The number of buffers is correct.
/// * The buffers are correctly aligned.
/// * The number of children is correct.
///
/// Do not validate that children can be accessed as this will trigger eager recursive validation.
pub trait ValidateVTable<Array> {
    fn validate(&self, _array: &Array) -> VortexResult<()> {
        // TODO(ngates): remove this default implementation once we migrate Arrays to
        //  [u8] metadata.
        Ok(())
    }
}

impl<E: Encoding> ValidateVTable<Array> for E
where
    E: ValidateVTable<E::Array>,
    for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,
{
    fn validate(&self, array: &Array) -> VortexResult<()> {
        let (array_ref, encoding) = array
            .try_downcast_ref::<E>()
            .vortex_expect("Failed to downcast encoding");
        encoding.validate(array_ref)
    }
}