Struct arrow::array::FixedSizeBinaryArray

pub struct FixedSizeBinaryArray { /* fields omitted */ }

A type of FixedSizeListArray whose elements are binaries.

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(input_arg.into_iter()).unwrap();
   assert_eq!(5, arr.len())

Implementations

impl FixedSizeBinaryArray

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

Returns the element at index i as a byte slice.

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.

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.

pub fn value_data(&self) -> Buffer

Returns a clone of the value data buffer

pub fn try_from_sparse_iter<T, U>(iter: T) -> 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.

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.

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.

Trait Implementations

impl Array for FixedSizeBinaryArray

fn get_buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied by the buffers owned by this FixedSizeBinaryArray.

fn get_array_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied physically by this FixedSizeBinaryArray.

fn as_any(&self) -> &dyn Any

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

fn data(&self) -> &ArrayData

Returns a reference to the underlying data of this array.

fn data_ref(&self) -> &ArrayData

Returns a reference-counted pointer to the underlying data of this array.

fn data_type(&self) -> &DataType

Returns a reference to the DataType of this array.

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

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

fn len(&self) -> usize

Returns the length (i.e., number of elements) of this array.

fn is_empty(&self) -> bool

Returns whether this array is empty.

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.

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

Returns whether the element at index is null. When using this function on a slice, the index is relative to the slice.

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

Returns whether the element at index is not null. When using this function on a slice, the index is relative to the slice.

fn null_count(&self) -> usize

Returns the total number of null values in this array.

fn to_raw(&self) -> Result<(*const FFI_ArrowArray, *const FFI_ArrowSchema)>

returns two pointers that represent this array in the C Data Interface (FFI)

impl Debug for FixedSizeBinaryArray

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

Formats the value using the given formatter.

impl From<ArrayData> for FixedSizeBinaryArray

fn from(data: ArrayData) -> Self

Performs the conversion.

impl From<FixedSizeListArray> for FixedSizeBinaryArray

Creates a FixedSizeBinaryArray from FixedSizeList<u8> array

fn from(v: FixedSizeListArray) -> Self

Performs the conversion.

impl JsonEqual for FixedSizeBinaryArray

fn equals_json(&self, json: &[&Value]) -> bool

Checks whether arrow array equals to json array.

fn equals_json_values(&self, json: &[Value]) -> bool

Checks whether arrow array equals to json array.

impl PartialEq<FixedSizeBinaryArray> for FixedSizeBinaryArray

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

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

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

This method tests for !=.

impl PartialEq<FixedSizeBinaryArray> for Value

fn eq(&self, arrow: &FixedSizeBinaryArray) -> bool

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

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

This method tests for !=.

impl PartialEq<Value> for FixedSizeBinaryArray

fn eq(&self, json: &Value) -> bool

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

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

This method tests for !=.