arrow_buffer

Trait ArrowNativeType

Source
pub trait ArrowNativeType:
    Debug
    + Send
    + Sync
    + Copy
    + PartialOrd
    + Default
    + Sealed
    + 'static {
    // Required methods
    fn from_usize(_: usize) -> Option<Self>;
    fn as_usize(self) -> usize;
    fn usize_as(i: usize) -> Self;
    fn to_usize(self) -> Option<usize>;
    fn to_isize(self) -> Option<isize>;
    fn to_i64(self) -> Option<i64>;

    // Provided method
    fn get_byte_width() -> usize { ... }
}
Expand description

Trait expressing a Rust type that has the same in-memory representation as Arrow.

This includes i16, f32, but excludes bool (which in arrow is represented in bits).

In little endian machines, types that implement ArrowNativeType can be memcopied to arrow buffers as is.

§Transmute Safety

A type T implementing this trait means that any arbitrary slice of bytes of length and alignment size_of::<T>() can be safely interpreted as a value of that type without being unsound, i.e. potentially resulting in undefined behaviour.

Note: in the case of floating point numbers this transmutation can result in a signalling NaN, which, whilst sound, can be unwieldy. In general, whilst it is perfectly sound to reinterpret bytes as different types using this trait, it is likely unwise. For more information see f32::from_bits and f64::from_bits.

Note: bool is restricted to 0 or 1, and so bool: !ArrowNativeType

§Sealed

Due to the above restrictions, this trait is sealed to prevent accidental misuse

Required Methods§

Source

fn from_usize(_: usize) -> Option<Self>

Convert native integer type from usize

Returns None if Self is not an integer or conversion would result in truncation/overflow

Source

fn as_usize(self) -> usize

Convert to usize according to the as operator

Source

fn usize_as(i: usize) -> Self

Convert from usize according to the as operator

Source

fn to_usize(self) -> Option<usize>

Convert native type to usize.

Returns None if Self is not an integer or conversion would result in truncation/overflow

Source

fn to_isize(self) -> Option<isize>

Convert native type to isize.

Returns None if Self is not an integer or conversion would result in truncation/overflow

Source

fn to_i64(self) -> Option<i64>

Convert native type to i64.

Returns None if Self is not an integer or conversion would result in truncation/overflow

Provided Methods§

Source

fn get_byte_width() -> usize

Returns the byte width of this native type.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types§

Source§

impl ArrowNativeType for f32

Source§

impl ArrowNativeType for f64

Source§

impl ArrowNativeType for i8

Source§

impl ArrowNativeType for i16

Source§

impl ArrowNativeType for i32

Source§

impl ArrowNativeType for i64

Source§

impl ArrowNativeType for i128

Source§

impl ArrowNativeType for u8

Source§

impl ArrowNativeType for u16

Source§

impl ArrowNativeType for u32

Source§

impl ArrowNativeType for u64

Source§

impl ArrowNativeType for u128

Source§

impl ArrowNativeType for f16

Implementors§