Struct VariantMetadata

pub struct VariantMetadata<'m> {
    bytes: &'m [u8],
    header: VariantMetadataHeader,
    dict_size: usize,
    dictionary_key_start_byte: usize,
}

Encodes the Variant Metadata, see the Variant spec file for more information

Fields

bytes: &'m [u8]

header: VariantMetadataHeader

dict_size: usize

dictionary_key_start_byte: usize

Implementations

impl<'m> VariantMetadata<'m>

pub const fn as_bytes(&self) -> &'m [u8]

View the raw bytes (needed by very low-level decoders)

pub fn try_new(bytes: &'m [u8]) -> Result<Self, ArrowError>

pub fn is_sorted(&self) -> bool

Whether the dictionary keys are sorted and unique

pub fn dictionary_size(&self) -> usize

Get the dictionary size

pub fn version(&self) -> u8

fn get_offsets_for_key_by( &self, index: usize, ) -> Result<Range<usize>, ArrowError>

Helper method to get the offset start and end range for a key by index.

pub fn get_offset_by(&self, index: usize) -> Result<usize, ArrowError>

Get a single offset by index

pub fn get_field_by(&self, index: usize) -> Result<&'m str, ArrowError>

Get the key-name by index

pub(crate) fn get_field_by_offset( &self, offset: Range<usize>, ) -> Result<&'m str, ArrowError>

Gets the field using an offset (Range) - helper method to keep consistent API.

pub fn header(&self) -> VariantMetadataHeader

pub fn offsets( &self, ) -> impl Iterator<Item = Result<Range<usize>, ArrowError>> + 'm

Get the offsets as an iterator

pub fn fields( &'m self, ) -> Result<impl Iterator<Item = Result<&'m str, ArrowError>>, ArrowError>

Get all key-names as an Iterator of strings

Trait Implementations

impl<'m> Clone for VariantMetadata<'m>

fn clone(&self) -> VariantMetadata<'m>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'m> Debug for VariantMetadata<'m>

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

Formats the value using the given formatter.

impl<'m> PartialEq for VariantMetadata<'m>

fn eq(&self, other: &VariantMetadata<'m>) -> 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<'m> Copy for VariantMetadata<'m>

impl<'m> StructuralPartialEq for VariantMetadata<'m>