Struct arrow_format::ipc::Field

pub struct Field {
    pub name: Option<String>,
    pub nullable: bool,
    pub type_: Option<Type>,
    pub dictionary: Option<Box<DictionaryEncoding>>,
    pub children: Option<Vec<Field>>,
    pub custom_metadata: Option<Vec<KeyValue>>,
}

Available on crate feature ipc only.

Fields

name: Option<String>

nullable: bool

type_: Option<Type>

dictionary: Option<Box<DictionaryEncoding>>

children: Option<Vec<Field>>

custom_metadata: Option<Vec<KeyValue>>

Implementations

impl Field

pub fn create(
    builder: &mut Builder,
    name: impl WriteAsOptional<Offset<str>>,
    nullable: impl WriteAsDefault<bool, bool>,
    type_: impl WriteAsOptionalUnion<Type>,
    dictionary: impl WriteAsOptional<Offset<DictionaryEncoding>>,
    children: impl WriteAsOptional<Offset<[Offset<Field>]>>,
    custom_metadata: impl WriteAsOptional<Offset<[Offset<KeyValue>]>>
) -> Offset<Self>

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Field> for Field

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<FieldRef<'a>> for Field

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: FieldRef<'a>) -> Result<Self>

Performs the conversion.

impl StructuralPartialEq for Field

impl VectorWrite<Offset<Field>> for Field

impl WriteAs<Offset<Field>> for Field

impl WriteAsOffset<Field> for Field

impl WriteAsOptional<Offset<Field>> for Field