Struct DictionaryBatch

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

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

Fields

_tab: Table<'a>

Implementations

impl<'a> DictionaryBatch<'a>

pub const VT_ID: VOffsetT = 4u16

pub const VT_DATA: VOffsetT = 6u16

pub const VT_ISDELTA: VOffsetT = 8u16

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 DictionaryBatchArgs<'args>, ) -> WIPOffset<DictionaryBatch<'bldr>>

pub fn id(&self) -> i64

pub fn data(&self) -> Option<RecordBatch<'a>>

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

Trait Implementations

impl<'a> Clone for DictionaryBatch<'a>

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

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

type Inner = DictionaryBatch<'a>

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

Safety

impl<'a> PartialEq for DictionaryBatch<'a>

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

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

impl<'a> StructuralPartialEq for DictionaryBatch<'a>