Struct NdArrayType 

pub struct NdArrayType { /* private fields */ }

The nd extension type: the element field of the values, plus the attribute fields.

Implementations

impl NdArrayType

pub fn new(value_type: DataType, attrs: Fields) -> Self

An nd type with nullable values of value_type and the given attribute fields.

pub fn with_value_field(value_field: FieldRef, attrs: Fields) -> Self

An nd type with a custom item field for the values list, for example to keep nested extension metadata on the elements.

pub fn value_field(&self) -> &FieldRef

The item field of the values list.

pub fn value_type(&self) -> &DataType

The Arrow type of the array values.

pub fn attribute_fields(&self) -> &Fields

One field per attribute key. Empty when there are no attributes.

pub fn storage_type(&self) -> DataType

The storage type of this extension type.

pub fn has_attributes(&self) -> bool

True when the storage has an attrs field.

pub fn try_from_storage_type(data_type: &DataType) -> Result<Self>

Parse the storage layout. This ignores field metadata. An attrs struct with zero fields reads as no attributes.

pub fn to_field(&self, name: impl Into<String>, nullable: bool) -> Field

A field named name with this storage type and the extension tag.

Trait Implementations

impl Clone for NdArrayType

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NdArrayType

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

Formats the value using the given formatter.

impl Eq for NdArrayType

impl ExtensionType for NdArrayType

const NAME: &'static str = "nd_arrow.array"

The name identifying this extension type.

type Metadata = NdArrayMetadata

The metadata type of this extension type.

fn metadata(&self) -> &Self::Metadata

Returns a reference to the metadata of this extension type, or &() if if this extension type defines no metadata (Self::Metadata=()).

fn serialize_metadata(&self) -> Option<String>

Returns the serialized representation of the metadata of this extension type, or None if this extension type defines no metadata (Self::Metadata=()).

fn deserialize_metadata( metadata: Option<&str>, ) -> Result<Self::Metadata, ArrowError>

Deserialize the metadata of this extension type from the serialized representation of the metadata. An extension type that defines no metadata should expect None for the serialized metadata and return Ok(()).

fn supports_data_type(&self, data_type: &DataType) -> Result<(), ArrowError>

Returns Ok(()) iff the given data type is supported by this extension type.

fn try_new( data_type: &DataType, metadata: Self::Metadata, ) -> Result<Self, ArrowError>

Construct this extension type for a field with the given data type and metadata.

fn validate( data_type: &DataType, metadata: Self::Metadata, ) -> Result<(), ArrowError>

Validate this extension type for a field with the given data type and metadata.

fn try_new_from_field_metadata( data_type: &DataType, metadata: &HashMap<String, String>, ) -> Result<Self, ArrowError>

Construct this extension type from field metadata and data type.

impl PartialEq for NdArrayType

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for NdArrayType