Struct 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>>,
}

---

A field represents a named column in a record / row batch or child of a nested type.

Generated from these locations:

• Table Field in the file Schema.fbs:512

Fields

name: Option<String>

Name is not required (e.g., in a List)

nullable: bool

Whether or not this field can contain nulls. Should be true in general.

type_: Option<Type>

This is the type of the decoded value if the field is dictionary encoded.

dictionary: Option<Box<DictionaryEncoding>>

Present only if the field is dictionary encoded.

children: Option<Vec<Field>>

children apply only to nested data types like Struct, List and Union. For primitive types children will have length 0.

custom_metadata: Option<Vec<KeyValue>>

User-defined metadata

Implementations

impl Field

pub fn builder() -> FieldBuilder<()>

Creates a FieldBuilder for serializing an instance of this table.

pub fn create( builder: &mut Builder, field_name: impl WriteAsOptional<Offset<str>>, field_nullable: impl WriteAsDefault<bool, bool>, field_type_: impl WriteAsOptionalUnion<Type>, field_dictionary: impl WriteAsOptional<Offset<DictionaryEncoding>>, field_children: impl WriteAsOptional<Offset<[Offset<Field>]>>, 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 Default for Field

fn default() -> Self

Returns the “default value” for a type.

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 Hash for Field

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 Ord for Field

fn cmp(&self, other: &Field) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for Field

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

impl StructuralPartialEq for Field

impl VectorWrite<Offset<Field>> for Field

Safety

The planus compiler generates implementations that initialize the bytes in write_values.

impl WriteAs<Offset<Field>> for Field

impl WriteAsOffset<Field> for Field

impl<T0: WriteAsOptional<Offset<str>>, T1: WriteAsDefault<bool, bool>, T2: WriteAsOptionalUnion<Type>, T3: WriteAsOptional<Offset<DictionaryEncoding>>, T4: WriteAsOptional<Offset<[Offset<Field>]>>, T5: WriteAsOptional<Offset<[Offset<KeyValue>]>>> WriteAsOffset<Field> for FieldBuilder<(T0, T1, T2, T3, T4, T5)>

impl WriteAsOptional<Offset<Field>> for Field