Struct StructDType

pub struct StructDType { /* private fields */ }

A struct dtype is a list of names and corresponding dtypes

Implementations

impl StructDType

pub fn from_fb(fb_struct: Struct_<'_>, buffer: FlatBuffer) -> VortexResult<Self>

Creates a new instance from a flatbuffer-defined object and its underlying buffer.

impl StructDType

pub fn new(names: FieldNames, dtypes: Vec<DType>) -> Self

Create a new StructDType from a list of names and dtypes

pub fn from_fields(names: FieldNames, dtypes: Vec<FieldDType>) -> Self

Create a new StructDType from a list of names and FieldDType which can be either lazily or eagerly serialized.

pub fn names(&self) -> &FieldNames

Get the names of the fields in the struct

pub fn find(&self, field: &Field) -> Option<usize>

Find the index of a field.

pub fn find_name(&self, name: &str) -> Option<usize>

Find the index of a field by name Returns None if the field is not found

pub fn field_info(&self, field: &Field) -> VortexResult<FieldInfo>

Get information about the referenced field, either by name or index Returns an error if the field is not found

pub fn field_dtype(&self, index: usize) -> VortexResult<DType>

Get the type of specific field by index

pub fn dtypes(&self) -> impl ExactSizeIterator<Item = DType> + '_

Returns an ordered iterator over the members of Self.

pub fn project(&self, projection: &[Field]) -> VortexResult<Self>

Project a subset of fields from the struct Returns an error if any of the referenced fields are not found

Trait Implementations

impl Clone for StructDType

fn clone(&self) -> StructDType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructDType

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

Formats the value using the given formatter.

impl<T, V> FromIterator<(T, V)> for StructDType

where T: Into<FieldName>, V: Into<FieldDType>,

fn from_iter<I: IntoIterator<Item = (T, V)>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for StructDType

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 StructDType

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

fn partial_cmp(&self, other: &StructDType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for StructDType

impl StructuralPartialEq for StructDType