Struct DictionaryEncoding

pub struct DictionaryEncoding {
    pub id: i64,
    pub index_type: Option<Box<Int>>,
    pub is_ordered: bool,
    pub dictionary_kind: DictionaryKind,
}

The table DictionaryEncoding in the namespace org.apache.arrow.flatbuf

Generated from these locations:

• Table DictionaryEncoding in the file Schema.fbs:486

Fields

id: i64

The known dictionary id in the application where this data is used. In the file or streaming formats, the dictionary ids are found in the DictionaryBatch messages

index_type: Option<Box<Int>>

The dictionary indices are constrained to be non-negative integers. If this field is null, the indices must be signed int32. To maximize cross-language compatibility and performance, implementations are recommended to prefer signed integer types over unsigned integer types and to avoid uint64 indices unless they are required by an application.

is_ordered: bool

By default, dictionaries are not ordered, or the order does not have semantic meaning. In some statistical, applications, dictionary-encoding is used to represent ordered categorical data, and we provide a way to preserve that metadata here

dictionary_kind: DictionaryKind

The field dictionaryKind in the table DictionaryEncoding

Implementations

impl DictionaryEncoding

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

Creates a DictionaryEncodingBuilder for serializing an instance of this table.

pub fn create( builder: &mut Builder, field_id: impl WriteAsDefault<i64, i64>, field_index_type: impl WriteAsOptional<Offset<Int>>, field_is_ordered: impl WriteAsDefault<bool, bool>, field_dictionary_kind: impl WriteAsDefault<DictionaryKind, DictionaryKind>, ) -> Offset<Self>

Trait Implementations

impl Clone for DictionaryEncoding

fn clone(&self) -> DictionaryEncoding

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DictionaryEncoding

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

Formats the value using the given formatter.

impl Default for DictionaryEncoding

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DictionaryEncoding

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for DictionaryEncoding

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 DictionaryEncoding

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

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

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

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<DictionaryEncodingRef<'a>> for DictionaryEncoding

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for DictionaryEncoding

impl StructuralPartialEq for DictionaryEncoding

impl VectorWrite<Offset<DictionaryEncoding>> for DictionaryEncoding

Safety

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

impl WriteAs<Offset<DictionaryEncoding>> for DictionaryEncoding

impl WriteAsOffset<DictionaryEncoding> for DictionaryEncoding

impl<T0: WriteAsDefault<i64, i64>, T1: WriteAsOptional<Offset<Int>>, T2: WriteAsDefault<bool, bool>, T3: WriteAsDefault<DictionaryKind, DictionaryKind>> WriteAsOffset<DictionaryEncoding> for DictionaryEncodingBuilder<(T0, T1, T2, T3)>

impl WriteAsOptional<Offset<DictionaryEncoding>> for DictionaryEncoding