Enum DType

pub enum DType {
    Null,
    Bool(Nullability),
    Primitive(PType, Nullability),
    Decimal(DecimalDType, Nullability),
    Utf8(Nullability),
    Binary(Nullability),
    Struct(Arc<StructDType>, Nullability),
    List(Arc<DType>, Nullability),
    Extension(Arc<ExtDType>),
}

The logical types of elements in Vortex arrays.

Vortex arrays preserve a single logical type, while the encodings allow for multiple physical ways to encode that type.

Variants

Null

The logical null type (only has a single value, null)

Bool(Nullability)

The logical boolean type (true or false if non-nullable; true, false, or null if nullable)

Primitive(PType, Nullability)

Primitive, fixed-width numeric types (e.g., u8, i8, u16, i16, u32, i32, u64, i64, f32, f64)

Decimal(DecimalDType, Nullability)

Real numbers with fixed exact precision and scale.

Utf8(Nullability)

UTF-8 strings

Binary(Nullability)

Binary data

Struct(Arc<StructDType>, Nullability)

A struct is composed of an ordered list of fields, each with a corresponding name and DType

List(Arc<DType>, Nullability)

A variable-length list type, parameterized by a single element DType

Extension(Arc<ExtDType>)

User-defined extension types

Implementations

impl DType

pub fn to_arrow_schema(&self) -> VortexResult<Schema>

Convert a Vortex DType into an Arrow Schema.

pub fn to_arrow_dtype(&self) -> VortexResult<DataType>

Returns the Arrow DataType that best corresponds to this Vortex DType.

impl DType

pub const BYTES: Self

The default DType for bytes

pub fn nullability(&self) -> Nullability

Get the nullability of the DType

pub fn is_nullable(&self) -> bool

Check if the DType is nullable

pub fn as_nonnullable(&self) -> Self

Get a new DType with Nullability::NonNullable (but otherwise the same as self)

pub fn as_nullable(&self) -> Self

Get a new DType with Nullability::Nullable (but otherwise the same as self)

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

Get a new DType with the given nullability (but otherwise the same as self)

pub fn union_nullability(&self, other: Nullability) -> Self

Union the nullability of this dtype with the other nullability, returning a new dtype.

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

Check if self and other are equal, ignoring nullability

pub fn is_struct(&self) -> bool

Check if self is a StructDType

pub fn is_primitive(&self) -> bool

Check if self is a primitive tpye

pub fn to_ptype(&self) -> PType

Returns this DType’s PType if it is a primitive type, otherwise panics.

pub fn is_unsigned_int(&self) -> bool

Check if self is an unsigned integer

pub fn is_signed_int(&self) -> bool

Check if self is a signed integer

pub fn is_int(&self) -> bool

Check if self is an integer (signed or unsigned)

pub fn is_float(&self) -> bool

Check if self is a floating point number

pub fn is_boolean(&self) -> bool

Check if self is a boolean

pub fn is_binary(&self) -> bool

Check if self is a binary

pub fn is_utf8(&self) -> bool

Check if self is a utf8

pub fn is_extension(&self) -> bool

Check if self is an extension type

pub fn is_decimal(&self) -> bool

Check if self is a decimal type

pub fn as_decimal(&self) -> Option<&DecimalDType>

Check returns the inner decimal type if the dtype is a decimal

pub fn as_struct(&self) -> Option<&Arc<StructDType>>

Get the StructDType if self is a StructDType, otherwise None

pub fn as_list_element(&self) -> Option<&DType>

Get the inner dtype if self is a ListDType, otherwise None

impl DType

pub fn try_from_view(fb: DType<'_>, buffer: FlatBuffer) -> VortexResult<Self>

Create a new

Trait Implementations

impl Clone for DType

fn clone(&self) -> DType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DType

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

Formats the value using the given formatter.

impl Display for DType

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

Formats the value using the given formatter.

impl From<&DType> for DType

fn from(value: &DType) -> Self

Converts to this type from the input type.

impl From<DType> for FieldDType

fn from(value: DType) -> Self

Converts to this type from the input type.

impl From<PType> for &DType

fn from(item: PType) -> Self

Converts to this type from the input type.

impl From<PType> for DType

fn from(item: PType) -> Self

Converts to this type from the input type.

impl FromArrowType<&Field> for DType

fn from_arrow(field: &Field) -> Self

Convert the Arrow type to a Vortex type.

impl FromArrowType<&Schema> for DType

fn from_arrow(value: &Schema) -> Self

Convert the Arrow type to a Vortex type.

impl FromArrowType<(&DataType, Nullability)> for DType

fn from_arrow((data_type, nullability): (&DataType, Nullability)) -> Self

Convert the Arrow type to a Vortex type.

impl FromArrowType<Arc<Schema>> for DType

fn from_arrow(value: SchemaRef) -> Self

Convert the Arrow type to a Vortex type.

impl Hash for DType

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 DType

fn eq(&self, other: &DType) -> 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<&DType> for DType

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &DType) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&DType> for DecimalDType

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &DType) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&DType> for PType

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &DType) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<DType> for DecimalDType

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: DType) -> Result<Self, Self::Error>

Performs the conversion.

impl WriteFlatBuffer for DType

type Target<'a> = DType<'a>

fn write_flatbuffer<'fb>( &self, fbb: &mut FlatBufferBuilder<'fb>, ) -> WIPOffset<Self::Target<'fb>>

impl Eq for DType

impl FlatBufferRoot for DType

impl StructuralPartialEq for DType