Struct Footer

pub struct Footer {
    pub version: MetadataVersion,
    pub schema: Option<Box<Schema>>,
    pub dictionaries: Option<Vec<Block>>,
    pub record_batches: Option<Vec<Block>>,
    pub custom_metadata: Option<Vec<KeyValue>>,
}

---

Arrow File metadata

Generated from these locations:

• Table Footer in the file File.fbs:26

Fields

version: MetadataVersion

The field version in the table Footer

schema: Option<Box<Schema>>

The field schema in the table Footer

dictionaries: Option<Vec<Block>>

The field dictionaries in the table Footer

record_batches: Option<Vec<Block>>

The field recordBatches in the table Footer

custom_metadata: Option<Vec<KeyValue>>

User-defined metadata

Implementations

impl Footer

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

Creates a FooterBuilder for serializing an instance of this table.

pub fn create( builder: &mut Builder, field_version: impl WriteAsDefault<MetadataVersion, MetadataVersion>, field_schema: impl WriteAsOptional<Offset<Schema>>, field_dictionaries: impl WriteAsOptional<Offset<[Block]>>, field_record_batches: impl WriteAsOptional<Offset<[Block]>>, field_custom_metadata: impl WriteAsOptional<Offset<[Offset<KeyValue>]>>, ) -> Offset<Self>

Trait Implementations

impl Clone for Footer

fn clone(&self) -> Footer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Footer

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

Formats the value using the given formatter.

impl Default for Footer

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Footer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Footer

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 Footer

fn cmp(&self, other: &Footer) -> 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 Footer

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

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

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<FooterRef<'a>> for Footer

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Footer

impl StructuralPartialEq for Footer

impl VectorWrite<Offset<Footer>> for Footer

Safety

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

impl WriteAs<Offset<Footer>> for Footer

impl WriteAsOffset<Footer> for Footer

impl<T0: WriteAsDefault<MetadataVersion, MetadataVersion>, T1: WriteAsOptional<Offset<Schema>>, T2: WriteAsOptional<Offset<[Block]>>, T3: WriteAsOptional<Offset<[Block]>>, T4: WriteAsOptional<Offset<[Offset<KeyValue>]>>> WriteAsOffset<Footer> for FooterBuilder<(T0, T1, T2, T3, T4)>

impl WriteAsOptional<Offset<Footer>> for Footer