Struct DictionaryEncoding

pub struct DictionaryEncoding<'a> {
    pub _tab: Table<'a>,
}

Fields

_tab: Table<'a>

Implementations

impl<'a> DictionaryEncoding<'a>

pub const VT_ID: VOffsetT = 4u16

pub const VT_INDEXTYPE: VOffsetT = 6u16

pub const VT_ISORDERED: VOffsetT = 8u16

pub const VT_DICTIONARYKIND: VOffsetT = 10u16

pub unsafe fn init_from_table(table: Table<'a>) -> Self

pub fn create<'bldr: 'args, 'args: 'mut_bldr, 'mut_bldr>( _fbb: &'mut_bldr mut FlatBufferBuilder<'bldr>, args: &'args DictionaryEncodingArgs<'args>, ) -> WIPOffset<DictionaryEncoding<'bldr>>

pub fn id(&self) -> 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

pub fn indexType(&self) -> Option<Int<'a>>

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.

pub fn isOrdered(&self) -> 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

pub fn dictionaryKind(&self) -> DictionaryKind

Trait Implementations

impl<'a> Clone for DictionaryEncoding<'a>

fn clone(&self) -> DictionaryEncoding<'a>

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

type Inner = DictionaryEncoding<'a>

unsafe fn follow(buf: &'a [u8], loc: usize) -> Self::Inner

Safety

impl<'a> PartialEq for DictionaryEncoding<'a>

fn eq(&self, other: &DictionaryEncoding<'a>) -> 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 Verifiable for DictionaryEncoding<'_>

fn run_verifier( v: &mut Verifier<'_, '_>, pos: usize, ) -> Result<(), InvalidFlatbuffer>

Runs the verifier for this type, assuming its at position pos in the verifier’s buffer. Should not need to be called directly.

impl<'a> Copy for DictionaryEncoding<'a>

impl<'a> StructuralPartialEq for DictionaryEncoding<'a>