Struct ArrowField

pub struct ArrowField {
    pub name: PlSmallStr,
    pub dtype: ArrowDataType,
    pub is_nullable: bool,
    pub metadata: Option<Arc<BTreeMap<PlSmallStr, PlSmallStr>>>,
}

Represents Arrow’s metadata of a “column”.

A Field is the closest representation of the traditional “column”: a logical type (ArrowDataType) with a name and nullability. A Field has optional [Metadata] that can be used to annotate the field with custom metadata.

Almost all IO in this crate uses Field to represent logical information about the data to be serialized.

Fields

name: PlSmallStr

Its name

dtype: ArrowDataType

Its logical ArrowDataType

is_nullable: bool

Its nullability

metadata: Option<Arc<BTreeMap<PlSmallStr, PlSmallStr>>>

Additional custom (opaque) metadata.

Implementations

impl Field

pub fn new(name: PlSmallStr, dtype: ArrowDataType, is_nullable: bool) -> Field

Creates a new Field.

pub fn with_metadata(self, metadata: BTreeMap<PlSmallStr, PlSmallStr>) -> Field

Creates a new Field with metadata.

pub fn dtype(&self) -> &ArrowDataType

Returns the Field’s ArrowDataType.

pub fn is_enum(&self) -> bool

pub fn is_categorical(&self) -> bool

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl Default for Field

fn default() -> Field

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Field

fn deserialize<__D>( __deserializer: __D, ) -> Result<Field, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Field> for Field

fn from(f: &Field) -> Field

Converts to this type from the input type.

impl From<Field> for (PlSmallStr, Field)

Support for ArrowSchema::from_iter([field, ..])

fn from(value: Field) -> (PlSmallStr, Field)

Converts to this type from the input type.

impl Hash for Field

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

where __H: Hasher,

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 Field

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Field

impl StructuralPartialEq for Field