Struct Field 

pub struct Field {
    pub name: String,
    pub dtype: ArrowType,
    pub nullable: bool,
    pub metadata: BTreeMap<String, String>,
}

Field

Description

Field struct supporting:

• Array metadata such as type, name, nullability, etc.
• Light metadata, e.g. a few key-value pairs.
• Later Schema construction during Arrow FFI.

Tips:

• Field is cloned often, so it is best kept any metadata lightweight to avoid performance penalties. SuperTable wraps it in Arc.

• For Datetime arrays, Field carries the logical Arrow type. The physical type remains a single integer-backed Datetime, while the logical type specifies its intended semantics. i.e.: Date32 Date64 Time32(TimeUnit) Time64(TimeUnit) Duration32(TimeUnit) Duration64(TimeUnit) Timestamp(TimeUnit) Interval(IntervalUnit)

• This ensures that when sent over Arrow C-FFI (or to_apache_arrow()), it converts to the correct external type. Whilst, avoiding proliferating many specialised types prematurely, keeping the API and binary size minimal.

Fields

name: String

dtype: ArrowType

nullable: bool

metadata: BTreeMap<String, String>

Implementations

impl Field

pub fn new<T>( name: T, dtype: ArrowType, nullable: bool, metadata: Option<BTreeMap<String, String>>, ) -> Field

where T: Into<String>,

Constructs a new Field. If the provided name is empty or only whitespace, a globally unique name like UnnamedField1 will generate.

pub fn from_array( name: impl Into<String>, array: &Array, metadata: Option<BTreeMap<String, String>>, ) -> Field

Constructs a new Field from an Array enum instance. Derives the dtype and nullability directly from the inner array.

For Duration, Time, Timestamp and Interval types, use Field::new().

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a duplicate 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 Display for Field

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

Formats the value using the given formatter.

impl Eq for Field

impl From<Arc<Field>> for Field

fn from(arc: Arc<Field>) -> 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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Field