Struct arrow2::array::FixedSizeBinaryArray

source ·
pub struct FixedSizeBinaryArray { /* private fields */ }
Expand description

The Arrow’s equivalent to an immutable Vec<Option<[u8; size]>>. Cloning and slicing this struct is O(1).

Implementations§

source§

impl<'a> FixedSizeBinaryArray

source

pub fn iter( &'a self ) -> ZipValidity<&'a [u8], ChunksExact<'a, u8>, BitmapIter<'a>>

constructs a new iterator

source

pub fn values_iter(&'a self) -> ChunksExact<'a, u8>

Returns iterator over the values of FixedSizeBinaryArray

source§

impl FixedSizeBinaryArray

source

pub fn try_new( data_type: DataType, values: Buffer<u8>, validity: Option<Bitmap> ) -> Result<Self, Error>

Creates a new FixedSizeBinaryArray.

§Errors

This function returns an error iff:

source

pub fn new( data_type: DataType, values: Buffer<u8>, validity: Option<Bitmap> ) -> Self

Creates a new FixedSizeBinaryArray.

§Panics

This function panics iff:

source

pub fn new_empty(data_type: DataType) -> Self

Returns a new empty FixedSizeBinaryArray.

source

pub fn new_null(data_type: DataType, length: usize) -> Self

Returns a new null FixedSizeBinaryArray.

source

pub fn boxed(self) -> Box<dyn Array>

Boxes self into a Box<dyn Array>.

source

pub fn arced(self) -> Arc<dyn Array>

Boxes self into a std::sync::Arc<dyn Array>.

source§

impl FixedSizeBinaryArray

source

pub fn slice(&self, offset: usize, length: usize) -> Self

Returns a slice of this FixedSizeBinaryArray.

§Implementation

This operation is O(1) as it amounts to increase 3 ref counts.

§Panics

panics iff offset + length > self.len()

source

pub unsafe fn slice_unchecked(&self, offset: usize, length: usize) -> Self

Returns a slice of this FixedSizeBinaryArray.

§Implementation

This operation is O(1) as it amounts to increase 3 ref counts.

§Safety

The caller must ensure that offset + length <= self.len().

source

pub fn with_validity(self, validity: Option<Bitmap>) -> Self

Returns this FixedSizeBinaryArray with a new validity.

§Panic

This function panics iff validity.len() != self.len().

source

pub fn set_validity(&mut self, validity: Option<Bitmap>)

Sets the validity of this FixedSizeBinaryArray.

§Panics

This function panics iff validity.len() != self.len().

source§

impl FixedSizeBinaryArray

source

pub fn len(&self) -> usize

Returns the length of this array

source

pub fn validity(&self) -> Option<&Bitmap>

The optional validity.

source

pub fn values(&self) -> &Buffer<u8>

Returns the values allocated on this FixedSizeBinaryArray.

source

pub fn value(&self, i: usize) -> &[u8]

Returns value at position i.

§Panic

Panics iff i >= self.len().

source

pub unsafe fn value_unchecked(&self, i: usize) -> &[u8]

Returns the element at index i as &str

§Safety

Assumes that the i < self.len.

source

pub fn to(self, data_type: DataType) -> Self

Returns a new FixedSizeBinaryArray with a different logical type. This is O(1).

§Panics

Panics iff the data_type is not supported for the physical type.

source

pub fn size(&self) -> usize

Returns the size

source§

impl FixedSizeBinaryArray

source

pub fn try_from_iter<P: AsRef<[u8]>, I: IntoIterator<Item = Option<P>>>( iter: I, size: usize ) -> Result<Self, Error>

Creates a FixedSizeBinaryArray from an fallible iterator of optional [u8].

source

pub fn from_iter<P: AsRef<[u8]>, I: IntoIterator<Item = Option<P>>>( iter: I, size: usize ) -> Self

Creates a FixedSizeBinaryArray from an iterator of optional [u8].

source

pub fn from_slice<const N: usize, P: AsRef<[[u8; N]]>>(a: P) -> Self

Creates a FixedSizeBinaryArray from a slice of arrays of bytes

source

pub fn from<const N: usize, P: AsRef<[Option<[u8; N]>]>>(slice: P) -> Self

Creates a new FixedSizeBinaryArray from a slice of optional [u8].

Trait Implementations§

source§

impl Array for FixedSizeBinaryArray

source§

fn as_any(&self) -> &dyn Any

Converts itself to a reference of Any, which enables downcasting to concrete types.
source§

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

Converts itself to a mutable reference of Any, which enables mutable downcasting to concrete types.
source§

fn len(&self) -> usize

The length of the Array. Every array has a length corresponding to the number of elements (slots).
source§

fn data_type(&self) -> &DataType

The DataType of the Array. In combination with Array::as_any, this can be used to downcast trait objects (dyn Array) to concrete arrays.
source§

fn validity(&self) -> Option<&Bitmap>

The validity of the Array: every array has an optional Bitmap that, when available specifies whether the array slot is valid or not (null). When the validity is None, all slots are valid.
source§

fn slice(&self, offset: usize, length: usize) -> Box<dyn Array>

Slices the Array, returning a new Box<dyn Array>. Read more
source§

unsafe fn slice_unchecked(&self, offset: usize, length: usize) -> Box<dyn Array>

Slices the Array, returning a new Box<dyn Array>. Read more
source§

fn with_validity(&self, validity: Option<Bitmap>) -> Box<dyn Array>

Clones this Array with a new new assigned bitmap. Read more
source§

fn to_boxed(&self) -> Box<dyn Array>

Clone a &dyn Array to an owned Box<dyn Array>.
source§

fn is_empty(&self) -> bool

whether the array is empty
source§

fn null_count(&self) -> usize

The number of null slots on this Array. Read more
source§

fn is_null(&self, i: usize) -> bool

Returns whether slot i is null. Read more
source§

fn is_valid(&self, i: usize) -> bool

Returns whether slot i is valid. Read more
source§

impl Clone for FixedSizeBinaryArray

source§

fn clone(&self) -> FixedSizeBinaryArray

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for FixedSizeBinaryArray

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> From<GrowableFixedSizeBinary<'a>> for FixedSizeBinaryArray

source§

fn from(val: GrowableFixedSizeBinary<'a>) -> Self

Converts to this type from the input type.
source§

impl From<MutableFixedSizeBinaryArray> for FixedSizeBinaryArray

source§

fn from(other: MutableFixedSizeBinaryArray) -> Self

Converts to this type from the input type.
source§

impl<'a> IntoIterator for &'a FixedSizeBinaryArray

§

type Item = Option<&'a [u8]>

The type of the elements being iterated over.
§

type IntoIter = ZipValidity<&'a [u8], ChunksExact<'a, u8>, BitmapIter<'a>>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl PartialEq<&(dyn Array + 'static)> for FixedSizeBinaryArray

source§

fn eq(&self, other: &&dyn Array) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq for FixedSizeBinaryArray

source§

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.