Struct arrow2::array::BinaryArray

pub struct BinaryArray<O: Offset> { /* fields omitted */ }

Implementations

impl<'a, O: Offset> BinaryArray<O>

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

Returns an iterator of Option<&[u8]>

pub fn values_iter(&'a self) -> BinaryValueIter<'a, O>

Returns an iterator of &[u8]

impl<O: Offset> BinaryArray<O>

pub fn from_slice<T: AsRef<[u8]>, P: AsRef<[T]>>(slice: P) -> Self

pub fn from<T: AsRef<[u8]>, P: AsRef<[Option<T>]>>(slice: P) -> Self

Creates a new BinaryArray from a slice of &[u8].

pub fn from_trusted_len_iter<I, P>(iterator: I) -> Self where
    P: AsRef<[u8]>,
    I: TrustedLen<Item = Option<P>>, 

Creates a BinaryArray from an iterator of trusted length.

impl<O: Offset> BinaryArray<O>

pub fn new_empty() -> Self

pub fn new_null(length: usize) -> Self

pub fn from_data(
    offsets: Buffer<O>,
    values: Buffer<u8>,
    validity: Option<Bitmap>
) -> Self

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

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

Returns the element at index i as &str

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

Returns the element at index i as &str

Safety

Assumes that the i < self.len.

pub fn offsets(&self) -> &Buffer<O>

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

Trait Implementations

impl<O: Offset> Array for BinaryArray<O>

fn as_any(&self) -> &dyn Any

fn len(&self) -> usize

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

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.

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.

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

Slices the Array, returning a new Box<dyn Array>.

fn is_empty(&self) -> bool

whether the array is empty

fn null_count(&self) -> usize

The number of null slots on this Array. This is usually used to branch implementations to cases where optimizations can be made.

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

Returns whether slot i is null.

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

Returns whether slot i is valid.

impl<O: Clone + Offset> Clone for BinaryArray<O>

fn clone(&self) -> BinaryArray<O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Debug + Offset> Debug for BinaryArray<O>

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

Formats the value using the given formatter.

impl<O: Offset> Display for BinaryArray<O>

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

Formats the value using the given formatter.

impl<'a, O: Offset> From<GrowableBinary<'a, O>> for BinaryArray<O>

fn from(val: GrowableBinary<'a, O>) -> Self

Performs the conversion.

impl<O: Offset> From<MutableBinaryArray<O>> for BinaryArray<O>

fn from(other: MutableBinaryArray<O>) -> Self

Performs the conversion.

impl<O: Offset, A: ArrowArrayRef> FromFfi<A> for BinaryArray<O>

fn try_from_ffi(array: A) -> Result<Self>

impl<O: Offset, P: AsRef<[u8]>> FromIterator<Option<P>> for BinaryArray<O>

fn from_iter<I: IntoIterator<Item = Option<P>>>(iter: I) -> Self

Creates a value from an iterator.

impl<O: Offset> GenericBinaryArray<O> for BinaryArray<O>

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

fn offsets(&self) -> &[O]

impl<'a, O: Offset> IntoIterator for &'a BinaryArray<O>

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

The type of the elements being iterated over.

type IntoIter = ZipValidity<'a, &'a [u8], BinaryValueIter<'a, O>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<O: Offset> PartialEq<&'_ (dyn Array + '_)> for BinaryArray<O>

fn eq(&self, other: &&dyn Array) -> 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<O: Offset> PartialEq<BinaryArray<O>> for BinaryArray<O>

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<O: Offset> ToFfi for BinaryArray<O>

fn buffers(&self) -> Vec<Option<NonNull<u8>>>

The pointers to the buffers.

fn offset(&self) -> usize

The offset

fn children(&self) -> Vec<Arc<dyn Array>>

The children