Struct arrow_array::array::FixedSizeBinaryArray

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

An array of fixed size binary arrays

§Examples

Create an array from an iterable argument of byte slices.

   use arrow_array::{Array, FixedSizeBinaryArray};
   let input_arg = vec![ vec![1, 2], vec![3, 4], vec![5, 6] ];
   let arr = FixedSizeBinaryArray::try_from_iter(input_arg.into_iter()).unwrap();

   assert_eq!(3, arr.len());

Create an array from an iterable argument of sparse byte slices. Sparsity means that the input argument can contain None items.

   use arrow_array::{Array, FixedSizeBinaryArray};
   let input_arg = vec![ None, Some(vec![7, 8]), Some(vec![9, 10]), None, Some(vec![13, 14]) ];
   let arr = FixedSizeBinaryArray::try_from_sparse_iter_with_size(input_arg.into_iter(), 2).unwrap();
   assert_eq!(5, arr.len())

Implementations§

source§

impl FixedSizeBinaryArray

source

pub fn new(size: i32, values: Buffer, nulls: Option<NullBuffer>) -> Self

Create a new FixedSizeBinaryArray with size element size, panicking on failure

§Panics

Panics if Self::try_new returns an error

source

pub fn try_new( size: i32, values: Buffer, nulls: Option<NullBuffer>, ) -> Result<Self, ArrowError>

Create a new FixedSizeBinaryArray from the provided parts, returning an error on failure

§Errors
  • size < 0
  • values.len() / size != nulls.len()
source

pub fn new_null(size: i32, len: usize) -> Self

Create a new FixedSizeBinaryArray of length len where all values are null

§Panics

Panics if

  • size < 0
  • size * len would overflow usize
source

pub fn into_parts(self) -> (i32, Buffer, Option<NullBuffer>)

Deconstruct this array into its constituent parts

source

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

Returns the element at index i as a byte slice.

§Panics

Panics if index i is out of bounds.

source

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

Returns the element at index i as a byte slice.

§Safety

Caller is responsible for ensuring that the index is within the bounds of the array

source

pub fn value_offset(&self, i: usize) -> i32

Returns the offset for the element at index i.

Note this doesn’t do any bound checking, for performance reason.

source

pub fn value_length(&self) -> i32

Returns the length for an element.

All elements have the same length as the array is a fixed size.

source

pub fn values(&self) -> &Buffer

Returns the values of this array.

Unlike Self::value_data this returns the Buffer allowing for zero-copy cloning.

source

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

Returns the raw value data.

source

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

Returns a zero-copy slice of this array with the indicated offset and length.

source

pub fn try_from_sparse_iter<T, U>(iter: T) -> Result<Self, ArrowError>
where T: Iterator<Item = Option<U>>, U: AsRef<[u8]>,

👎Deprecated: This function will fail if the iterator produces only None values; prefer try_from_sparse_iter_with_size

Create an array from an iterable argument of sparse byte slices. Sparsity means that items returned by the iterator are optional, i.e input argument can contain None items.

§Examples
use arrow_array::FixedSizeBinaryArray;
let input_arg = vec![
    None,
    Some(vec![7, 8]),
    Some(vec![9, 10]),
    None,
    Some(vec![13, 14]),
    None,
];
let array = FixedSizeBinaryArray::try_from_sparse_iter(input_arg.into_iter()).unwrap();
§Errors

Returns error if argument has length zero, or sizes of nested slices don’t match.

source

pub fn try_from_sparse_iter_with_size<T, U>( iter: T, size: i32, ) -> Result<Self, ArrowError>
where T: Iterator<Item = Option<U>>, U: AsRef<[u8]>,

Create an array from an iterable argument of sparse byte slices. Sparsity means that items returned by the iterator are optional, i.e input argument can contain None items. In cases where the iterator returns only None values, this also takes a size parameter to ensure that the a valid FixedSizeBinaryArray is still created.

§Examples
use arrow_array::FixedSizeBinaryArray;
let input_arg = vec![
    None,
    Some(vec![7, 8]),
    Some(vec![9, 10]),
    None,
    Some(vec![13, 14]),
    None,
];
let array = FixedSizeBinaryArray::try_from_sparse_iter_with_size(input_arg.into_iter(), 2).unwrap();
§Errors

Returns error if argument has length zero, or sizes of nested slices don’t match.

source

pub fn try_from_iter<T, U>(iter: T) -> Result<Self, ArrowError>
where T: Iterator<Item = U>, U: AsRef<[u8]>,

Create an array from an iterable argument of byte slices.

§Examples
use arrow_array::FixedSizeBinaryArray;
let input_arg = vec![
    vec![1, 2],
    vec![3, 4],
    vec![5, 6],
];
let array = FixedSizeBinaryArray::try_from_iter(input_arg.into_iter()).unwrap();
§Errors

Returns error if argument has length zero, or sizes of nested slices don’t match.

source

pub fn iter(&self) -> FixedSizeBinaryIter<'_>

constructs a new iterator

Trait Implementations§

source§

impl Array for FixedSizeBinaryArray

source§

fn as_any(&self) -> &dyn Any

Returns the array as Any so that it can be downcasted to a specific implementation. Read more
source§

fn to_data(&self) -> ArrayData

Returns the underlying data of this array
source§

fn into_data(self) -> ArrayData

Returns the underlying data of this array Read more
source§

fn data_type(&self) -> &DataType

Returns a reference to the DataType of this array. Read more
source§

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

Returns a zero-copy slice of this array with the indicated offset and length. Read more
source§

fn len(&self) -> usize

Returns the length (i.e., number of elements) of this array. Read more
source§

fn is_empty(&self) -> bool

Returns whether this array is empty. Read more
source§

fn offset(&self) -> usize

Returns the offset into the underlying data used by this array(-slice). Note that the underlying data can be shared by many arrays. This defaults to 0. Read more
source§

fn nulls(&self) -> Option<&NullBuffer>

Returns the null buffer of this array if any. Read more
source§

fn get_buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory pointed to by this array. The buffers store bytes in the Arrow memory format, and include the data as well as the validity map. Note that this does not always correspond to the exact memory usage of an array, since multiple arrays can share the same buffers or slices thereof.
source§

fn get_array_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied physically by this array. This value will always be greater than returned by get_buffer_memory_size() and includes the overhead of the data structures that contain the pointers to the various buffers.
source§

fn logical_nulls(&self) -> Option<NullBuffer>

Returns a potentially computed NullBuffer that represents the logical null values of this array, if any. Read more
source§

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

Returns whether the element at index is null according to Array::nulls Read more
source§

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

Returns whether the element at index is not null, the opposite of Self::is_null. Read more
source§

fn null_count(&self) -> usize

Returns the total number of physical null values in this array. Read more
source§

fn is_nullable(&self) -> bool

Returns false if the array is guaranteed to not contain any logical nulls Read more
source§

impl<'a> ArrayAccessor for &'a FixedSizeBinaryArray

§

type Item = &'a [u8]

The Arrow type of the element being accessed.
source§

fn value(&self, index: usize) -> Self::Item

Returns the element at index i Read more
source§

unsafe fn value_unchecked(&self, index: usize) -> Self::Item

Returns the element at index i 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 From<ArrayData> for FixedSizeBinaryArray

source§

fn from(data: ArrayData) -> Self

Converts to this type from the input type.
source§

impl From<FixedSizeBinaryArray> for ArrayData

source§

fn from(array: FixedSizeBinaryArray) -> Self

Converts to this type from the input type.
source§

impl From<FixedSizeListArray> for FixedSizeBinaryArray

Creates a FixedSizeBinaryArray from FixedSizeList<u8> array

source§

fn from(v: FixedSizeListArray) -> Self

Converts to this type from the input type.
source§

impl From<Vec<&[u8]>> for FixedSizeBinaryArray

source§

fn from(v: Vec<&[u8]>) -> Self

Converts to this type from the input type.
source§

impl From<Vec<Option<&[u8]>>> for FixedSizeBinaryArray

source§

fn from(v: Vec<Option<&[u8]>>) -> 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 = ArrayIter<&'a FixedSizeBinaryArray>

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 for FixedSizeBinaryArray

source§

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

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

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

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> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> Datum for T
where T: Array,

source§

fn get(&self) -> (&dyn Array, bool)

Returns the value for this Datum and a boolean indicating if the value is scalar
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.
source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,