Struct FixedLenByteArray

#[repr(transparent)]
pub struct FixedLenByteArray(ByteArray);

Wrapper type for performance reasons, this represents FIXED_LEN_BYTE_ARRAY but in all other considerations behaves the same as ByteArray

Performance notes:

This type is a little unfortunate, without it the compiler generates code that takes quite a big hit on the CPU pipeline. Essentially the previous version stalls awaiting the result of T::get_physical_type() == Type::FIXED_LEN_BYTE_ARRAY.

Its debatable if this is wanted, it is out of spec for what parquet documents as its base types, although there are code paths in the Rust (and potentially the C++) versions that warrant this.

With this wrapper type the compiler generates more targeted code paths matching the higher level logical types, removing the data-hazard from all decoding and encoding paths.

Tuple Fields

0: ByteArray

Methods from Deref<Target = ByteArray>

pub fn len(&self) -> usize

Gets length of the underlying byte buffer.

pub fn is_empty(&self) -> bool

Checks if the underlying buffer is empty.

pub fn data(&self) -> &[u8]

Returns slice of data.

pub fn set_data(&mut self, data: Bytes)

Set data from another byte buffer.

pub fn slice(&self, start: usize, len: usize) -> Self

Returns ByteArray instance with slice of values for a data.

pub fn as_utf8(&self) -> Result<&str>

Try to convert the byte array to a utf8 slice

Trait Implementations

impl AsBytes for FixedLenByteArray

fn as_bytes(&self) -> &[u8]

Returns slice of bytes for this data type.

impl AsRef<[u8]> for FixedLenByteArray

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for FixedLenByteArray

fn clone(&self) -> FixedLenByteArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FixedLenByteArray

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

Formats the value using the given formatter.

impl Default for FixedLenByteArray

fn default() -> FixedLenByteArray

Returns the “default value” for a type.

impl Deref for FixedLenByteArray

type Target = ByteArray

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for FixedLenByteArray

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for FixedLenByteArray

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

Formats the value using the given formatter.

impl From<ByteArray> for FixedLenByteArray

fn from(other: ByteArray) -> Self

Converts to this type from the input type.

impl From<FixedLenByteArray> for ByteArray

fn from(other: FixedLenByteArray) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for FixedLenByteArray

fn from(buf: Vec<u8>) -> FixedLenByteArray

Converts to this type from the input type.

impl HeapSize for FixedLenByteArray

fn heap_size(&self) -> usize

Return the size of any bytes allocated on the heap by this object, including heap memory in those structures

impl MakeStatistics for FixedLenByteArray

fn make_statistics(statistics: ValueStatistics<Self>) -> Statistics

where Self: Sized,

impl ParquetValueType for FixedLenByteArray

const PHYSICAL_TYPE: Type = Type::FIXED_LEN_BYTE_ARRAY

fn encode<W: Write>( values: &[Self], writer: &mut W, _: &mut BitWriter, ) -> Result<()>

Encode the value directly from a higher level encoder

fn set_data(decoder: &mut PlainDecoderDetails, data: Bytes, num_values: usize)

Establish the data that will be decoded in a buffer

fn decode( buffer: &mut [Self], decoder: &mut PlainDecoderDetails, ) -> Result<usize>

Decode the value from a given buffer for a higher level decoder

fn skip(decoder: &mut PlainDecoderDetails, num_values: usize) -> Result<usize>

fn dict_encoding_size(&self) -> (usize, usize)

Return the encoded size for a type

fn as_any(&self) -> &dyn Any

Return the value as an Any to allow for downcasts without transmutation

fn as_mut_any(&mut self) -> &mut dyn Any

Return the value as an mutable Any to allow for downcasts without transmutation

fn set_from_bytes(&mut self, data: Bytes)

Sets the value of this object from the provided [Bytes]

fn variable_length_bytes(_: &[Self]) -> Option<i64>

Return the number of variable length bytes in a given slice of data

fn as_i64(&self) -> Result<i64>

Return the value as i64 if possible

fn as_u64(&self) -> Result<u64>

Return the value as u64 if possible

impl PartialEq<ByteArray> for FixedLenByteArray

fn eq(&self, other: &ByteArray) -> 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 PartialEq<FixedLenByteArray> for ByteArray

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

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

fn partial_cmp(&self, other: &ByteArray) -> 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 PartialOrd<FixedLenByteArray> for ByteArray

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

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

fn slice_as_bytes(_self: &[Self]) -> &[u8]

Returns slice of bytes for a slice of this data type.

unsafe fn slice_as_bytes_mut(_self: &mut [Self]) -> &mut [u8]

Return the internal representation as a mutable slice