Struct DictionaryBatch

pub struct DictionaryBatch {
    pub id: i64,
    pub data: Option<Box<RecordBatch>>,
    pub is_delta: bool,
}

For sending dictionary encoding information. Any Field can be dictionary-encoded, but in this case none of its children may be dictionary-encoded. There is one vector / column per dictionary, but that vector / column may be spread across multiple dictionary batches by using the isDelta flag

Generated from these locations:

• Table DictionaryBatch in the file Message.fbs:127

Fields

id: i64

The field id in the table DictionaryBatch

data: Option<Box<RecordBatch>>

The field data in the table DictionaryBatch

is_delta: bool

If isDelta is true the values in the dictionary are to be appended to a dictionary with the indicated id. If isDelta is false this dictionary should replace the existing dictionary.

Implementations

impl DictionaryBatch

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

Creates a DictionaryBatchBuilder for serializing an instance of this table.

pub fn create( builder: &mut Builder, field_id: impl WriteAsDefault<i64, i64>, field_data: impl WriteAsOptional<Offset<RecordBatch>>, field_is_delta: impl WriteAsDefault<bool, bool>, ) -> Offset<Self>

Trait Implementations

impl Clone for DictionaryBatch

fn clone(&self) -> DictionaryBatch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DictionaryBatch

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

Formats the value using the given formatter.

impl Default for DictionaryBatch

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DictionaryBatch

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for DictionaryBatch

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 DictionaryBatch

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

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

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

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<DictionaryBatchRef<'a>> for DictionaryBatch

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for DictionaryBatch

impl StructuralPartialEq for DictionaryBatch

impl VectorWrite<Offset<DictionaryBatch>> for DictionaryBatch

Safety

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

impl WriteAs<Offset<DictionaryBatch>> for DictionaryBatch

impl WriteAsOffset<DictionaryBatch> for DictionaryBatch

impl<T0: WriteAsDefault<i64, i64>, T1: WriteAsOptional<Offset<RecordBatch>>, T2: WriteAsDefault<bool, bool>> WriteAsOffset<DictionaryBatch> for DictionaryBatchBuilder<(T0, T1, T2)>

impl WriteAsOptional<Offset<DictionaryBatch>> for DictionaryBatch