Struct ExtDType

pub struct ExtDType { /* private fields */ }

A type descriptor for an extension type

Implementations

impl ExtDType

pub fn new( id: ExtID, storage_dtype: Arc<DType>, metadata: Option<ExtMetadata>, ) -> Self

Creates a new ExtDType.

Extension data types in Vortex allows library users to express additional semantic meaning on top of a set of scalar values. Metadata can optionally be provided for the extension type to allow for parameterized types.

A simple example would be if one wanted to create a vortex.temperature extension type. The canonical encoding for such values would be f64, and the metadata can contain an optional temperature unit, allowing downstream users to be sure they properly account for Celsius and Fahrenheit conversions.

use std::sync::Arc;
use vortex_dtype::{DType, ExtDType, ExtID, ExtMetadata, Nullability, PType};

#[repr(u8)]
enum TemperatureUnit {
    C = 0u8,
    F = 1u8,
}

// Make a new extension type that encodes the unit for a set of nullable `f64`.
pub fn create_temperature_type(unit: TemperatureUnit) -> ExtDType {
    ExtDType::new(
        ExtID::new("vortex.temperature".into()),
        Arc::new(DType::Primitive(PType::F64, Nullability::Nullable)),
        Some(ExtMetadata::new([unit as u8].into()))
    )
}

pub fn id(&self) -> &ExtID

Returns the ExtID for this extension type

pub fn storage_dtype(&self) -> &DType

Returns the ExtMetadata for this extension type, if it exists

pub fn with_nullability(&self, nullability: Nullability) -> Self

Returns a new ExtDType with the given nullability

pub fn metadata(&self) -> Option<&ExtMetadata>

Returns the ExtMetadata for this extension type, if it exists

pub fn eq_ignore_nullability(&self, other: &Self) -> bool

Check if self and other are equal, ignoring the storage nullability

Trait Implementations

impl Clone for ExtDType

fn clone(&self) -> ExtDType

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExtDType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for ExtDType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ExtDType

fn eq(&self, other: &ExtDType) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&ExtDType> for TemporalMetadata

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(ext_dtype: &ExtDType) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ExtDType> for TemporalMetadata

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(ext_dtype: ExtDType) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ExtDType

impl StructuralPartialEq for ExtDType