Struct Serializer

pub struct Serializer<A>(/* private fields */);

Wrap an ArrayBuilder with as a Serializer

To support serialization, the wrapped object must implement AsMut<ArrayBuilder>. This requirement is covered by ArrayBuilder and mutable references to an ArrayBuilder.

Calls to serialize will return the Serializer itself on success. Therefore the the underlying ArrayBuilder passed to Serializer::new and be retrieved and be used to construct the arrays.

Usage:

use serde_arrow::{ArrayBuilder, Serializer};

let mut builder = ArrayBuilder::from_arrow(&fields)?;

// note: when constructing the serialize with a mutable reference,
// different item sequences can be pushed into the same builder
items1.serialize(Serializer::new(&mut builder))?;
items2.serialize(Serializer::new(&mut builder))?;

let batch = builder.to_record_batch()?;
assert_eq!(batch.num_rows(), items1.len() + items2.len());

Implementations

impl<A> Serializer<A>

pub fn new(inner: A) -> Self

Construct a new serializer from an array builder

See the Serializer docs for details

pub fn into_inner(self) -> A

Extract the wrapped array builder

Trait Implementations

impl<A: AsMut<ArrayBuilder>> Serializer for Serializer<A>

type Error = Error

The error type when some error occurs during serialization.

type Ok = Serializer<A>

The output type produced by this Serializer during successful serialization. Most serializers that produce text or binary output should set Ok = () and serialize into an io::Write or buffer contained within the Serializer instance. Serializers that build in-memory data structures may be simplified by using Ok to propagate the data structure around.

type SerializeSeq = CollectionSerializer<A>

Type returned from serialize_seq for serializing the content of the sequence.

type SerializeTuple = CollectionSerializer<A>

Type returned from serialize_tuple for serializing the content of the tuple.

type SerializeTupleStruct = CollectionSerializer<A>

Type returned from serialize_tuple_struct for serializing the content of the tuple struct.

type SerializeTupleVariant = CollectionSerializer<A>

Type returned from serialize_tuple_variant for serializing the content of the tuple variant.

type SerializeMap = Impossible<<Serializer<A> as Serializer>::Ok, <Serializer<A> as Serializer>::Error>

Type returned from serialize_map for serializing the content of the map.

type SerializeStruct = Impossible<<Serializer<A> as Serializer>::Ok, <Serializer<A> as Serializer>::Error>

Type returned from serialize_struct for serializing the content of the struct.

type SerializeStructVariant = Impossible<<Serializer<A> as Serializer>::Ok, <Serializer<A> as Serializer>::Error>

Type returned from serialize_struct_variant for serializing the content of the struct variant.

fn serialize_seq(self, _len: Option<usize>) -> Result<Self::SerializeSeq>

Begin to serialize a variably sized sequence. This call must be followed by zero or more calls to serialize_element, then a call to end.

fn serialize_tuple(self, _: usize) -> Result<Self::SerializeTuple>

Begin to serialize a statically sized sequence whose length will be known at deserialization time without looking at the serialized data. This call must be followed by zero or more calls to serialize_element, then a call to end.

fn serialize_tuple_struct( self, _: &'static str, _: usize, ) -> Result<Self::SerializeTupleStruct>

Begin to serialize a tuple struct like struct Rgb(u8, u8, u8). This call must be followed by zero or more calls to serialize_field, then a call to end.

fn serialize_tuple_variant( self, _: &'static str, _: u32, _: &'static str, _: usize, ) -> Result<Self::SerializeTupleVariant>

Begin to serialize a tuple variant like E::T in enum E { T(u8, u8) }. This call must be followed by zero or more calls to serialize_field, then a call to end.

fn serialize_newtype_struct<T: Serialize + ?Sized>( self, _: &'static str, value: &T, ) -> Result<Self::Ok>

Serialize a newtype struct like struct Millimeters(u8).

fn serialize_newtype_variant<T: Serialize + ?Sized>( self, _: &'static str, _: u32, _: &'static str, value: &T, ) -> Result<Self::Ok>

Serialize a newtype variant like E::N in enum E { N(u8) }.

fn serialize_bool(self, _: bool) -> Result<Self::Ok>

Serialize a bool value.

fn serialize_bytes(self, _: &[u8]) -> Result<Self::Ok>

Serialize a chunk of raw byte data.

fn serialize_char(self, _: char) -> Result<Self::Ok>

Serialize a character.

fn serialize_f32(self, _: f32) -> Result<Self::Ok>

Serialize an f32 value.

fn serialize_f64(self, _: f64) -> Result<Self::Ok>

Serialize an f64 value.

fn serialize_i8(self, _: i8) -> Result<Self::Ok>

Serialize an i8 value.

fn serialize_i16(self, _: i16) -> Result<Self::Ok>

Serialize an i16 value.

fn serialize_i32(self, _: i32) -> Result<Self::Ok>

Serialize an i32 value.

fn serialize_i64(self, _: i64) -> Result<Self::Ok>

Serialize an i64 value.

fn serialize_i128(self, _: i128) -> Result<Self::Ok>

Serialize an i128 value.

fn serialize_map(self, _: Option<usize>) -> Result<Self::SerializeMap>

Begin to serialize a map. This call must be followed by zero or more calls to serialize_key and serialize_value, then a call to end.

fn serialize_none(self) -> Result<Self::Ok>

Serialize a None value.

fn serialize_some<T: Serialize + ?Sized>(self, _: &T) -> Result<Self::Ok>

Serialize a Some(T) value.

fn serialize_str(self, _: &str) -> Result<Self::Ok>

Serialize a &str.

fn serialize_struct( self, _: &'static str, _: usize, ) -> Result<Self::SerializeStruct>

Begin to serialize a struct like struct Rgb { r: u8, g: u8, b: u8 }. This call must be followed by zero or more calls to serialize_field, then a call to end.

fn serialize_struct_variant( self, _: &'static str, _: u32, _: &'static str, _: usize, ) -> Result<Self::SerializeStructVariant>

Begin to serialize a struct variant like E::S in enum E { S { r: u8, g: u8, b: u8 } }. This call must be followed by zero or more calls to serialize_field, then a call to end.

fn serialize_u8(self, _: u8) -> Result<Self::Ok>

Serialize a u8 value.

fn serialize_u16(self, _: u16) -> Result<Self::Ok>

Serialize a u16 value.

fn serialize_u32(self, _: u32) -> Result<Self::Ok>

Serialize a u32 value.

fn serialize_u64(self, _: u64) -> Result<Self::Ok>

Serialize a u64 value.

fn serialize_u128(self, _: u128) -> Result<Self::Ok, Self::Error>

Serialize a u128 value.

fn serialize_unit(self) -> Result<Self::Ok>

Serialize a () value.

fn serialize_unit_struct(self, _: &'static str) -> Result<Self::Ok>

Serialize a unit struct like struct Unit or PhantomData<T>.

fn serialize_unit_variant( self, _: &'static str, _: u32, _: &'static str, ) -> Result<Self::Ok>

Serialize a unit variant like E::A in enum E { A, B }.

fn is_human_readable(&self) -> bool

Determine whether Serialize implementations should serialize in human-readable form.

fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error>

where I: IntoIterator, <I as IntoIterator>::Item: Serialize,

Collect an iterator as a sequence.

fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error>

where K: Serialize, V: Serialize, I: IntoIterator<Item = (K, V)>,

Collect an iterator as a map.

fn collect_str<T>(self, value: &T) -> Result<Self::Ok, Self::Error>

where T: Display + ?Sized,

Serialize a string produced by an implementation of Display.