Skip to main content

BooleanArrayV

Struct BooleanArrayV 

Source
pub struct BooleanArrayV {
    pub array: Arc<BooleanArray<()>>,
    pub offset: usize,
    /* private fields */
}
Expand description

§BooleanArrayView

Borrowed, indexable view into a [offset .. offset + len) window of a BooleanArray.

§Purpose

  • Zero-copy access to contiguous bit-packed boolean values.
  • Allows null counts for the view to be cached to speed up scans.

§Fields

  • array: the backing BooleanArray wrapped in Arc.
  • offset: starting index of the view.
  • len: number of logical elements in the view.
  • null_count: cached null count for this range.

§Notes

Fields§

§array: Arc<BooleanArray<()>>

The outer array that this view is derived from - we retain a reference to it. Importantly, this is the full array - not the view, and thus should not be accessed as though it were the view subset.

§offset: usize

The index offset from 0 that for where this view starts from the outer array

Implementations§

Source§

impl BooleanArrayV

Source

pub fn new(array: Arc<BooleanArray<()>>, offset: usize, len: usize) -> Self

Creates a new BooleanArrayView with the given offset and length.

Source

pub fn new_nc( array: Arc<BooleanArray<()>>, offset: usize, len: usize, null_count: usize, ) -> Self

Creates a new BooleanArrayView with a precomputed null count.

Source

pub fn is_empty(&self) -> bool

Returns true if the view is empty.

Source

pub fn get_bool(&self, i: usize) -> Option<bool>

Returns the value at logical index i as an Option<bool>.

Source

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

Returns a sliced view into a subrange of this view.

Source

pub fn len(&self) -> usize

Returns the length of the window.

Source

pub fn inner_array(&self) -> Array

Returns the full backing array wrapped as an Array enum, ignoring the view’s offset and length.

Use this to access inner array methods. The returned array is the unwindowed original.

Source

pub fn to_boolean_array(&self) -> Arc<BooleanArray<()>>

Returns an owned BooleanArray for the window.

If the view covers the entire backing array, returns a cheap Arc clone of the original allocation. Otherwise deep-copies the window via slice_clone through inner_array.

Source

pub fn end(&self) -> usize

Returns the end index of the view.

Source

pub fn as_tuple(&self) -> (Arc<BooleanArray<()>>, usize, usize)

Returns the view as a tuple (array, offset, len).

Source

pub fn as_tuple_ref(&self) -> (&BooleanArray<()>, usize, usize)

Returns a reference tuple: (&BooleanArray, offset, len).

This avoids cloning the Arc and returns a reference with a lifetime tied to this BooleanArrayV.

Source

pub fn null_count(&self) -> usize

Returns the number of nulls in the view.

Caches it after the first calculation.

Source

pub fn has_nulls(&self) -> bool

Returns true when the windowed view holds at least one null.

Reads through null_count, so the cached value is trusted when set and the full popcount is only paid on the first call that observes this view.

Source

pub fn null_mask_view(&self) -> Option<BitmaskV<'_>>

Returns the null mask as a windowed BitmaskView.

Source

pub fn set_null_count(&self, count: usize) -> Result<(), usize>

Sets the cached null count for the view.

Returns Ok(()) if the value was set, or Err(count) if it was already initialised. This is thread-safe and can only succeed once per BooleanArrayV instance.

Trait Implementations§

Source§

impl Clone for BooleanArrayV

Source§

fn clone(&self) -> BooleanArrayV

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Concatenate for BooleanArrayV

Source§

fn concat(self, other: Self) -> Result<Self, MinarrowError>

Concatenates two boolean array views by materialising both to owned boolean arrays, concatenating them, and wrapping the result back in a view.

§Notes
  • This operation copies data from both views to create owned boolean arrays.
  • The resulting view has offset=0 and length equal to the combined length.
Source§

impl Debug for BooleanArrayV

Source§

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

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

impl Display for BooleanArrayV

Source§

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

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

impl From<Arc<BooleanArray<()>>> for BooleanArrayV

Source§

fn from(array: Arc<BooleanArray<()>>) -> Self

Converts to this type from the input type.
Source§

impl From<Array> for BooleanArrayV

Source§

fn from(array: Array) -> Self

Converts to this type from the input type.
Source§

impl From<ArrayV> for BooleanArrayV

Source§

fn from(view: ArrayV) -> Self

Converts to this type from the input type.
Source§

impl From<BooleanArrayV> for Value

Available on crate feature views only.

Wrap a BooleanArrayV as Value::ArrayView. The view’s offset and length are preserved on the inner ArrayV. The full null mask carried by the underlying BooleanArray is preserved.

Source§

fn from(v: BooleanArrayV) -> Self

Converts to this type from the input type.
Source§

impl From<BooleanArrayV> for ArrayV

Available on crate feature views only.

BooleanArrayView -> ArrayView

Converts by wrapping the inner Arc as Array::BooleanArray.

Source§

fn from(view: BooleanArrayV) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for BooleanArrayV

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Shape for BooleanArrayV

Source§

fn shape(&self) -> ShapeDim

Returns arbitrary Shape dimension for any data shape
Source§

fn shape_1d(&self) -> usize

Returns the first dimension shape Read more
Source§

fn shape_2d(&self) -> (usize, usize)

Returns the first and second dimension shapes Read more
Source§

fn shape_3d(&self) -> (usize, usize, usize)

Returns the first, second and third dimension shapes Read more
Source§

fn shape_4d(&self) -> (usize, usize, usize, usize)

Returns the first, second, third and fourth dimension shapes Read more
Source§

impl StructuralPartialEq for BooleanArrayV

Source§

impl TryFrom<Value> for BooleanArrayV

Available on crate feature views only.
Source§

fn try_from(v: Value) -> Result<Self, Self::Error>

Accepts any Value that resolves to an Array carrying a BooleanArray payload. The conversion routes through ArrayV, so an incoming view keeps its window instead of materialising it, and every input Array accepts is accepted here too.

Source§

type Error = MinarrowError

The type returned in the event of a conversion error.

Auto Trait Implementations§

Blanket Implementations§

Source§

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

impl<T> CustomValue for T
where T: Any + Send + Sync + Clone + PartialEq + Debug,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Downcasts the type as Any
Source§

fn deep_clone(&self) -> Arc<dyn CustomValue>

Returns a deep clone of the object. Read more
Source§

fn eq_box(&self, other: &(dyn CustomValue + 'static)) -> bool

Performs semantic equality on the boxed object. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn align() -> usize

The alignment necessary for the key. Must return a power of two.
Source§

fn size(&self) -> usize

The size of the key in bytes.
Source§

unsafe fn init(&self, ptr: *mut u8)

Initialize the key in the given memory location. Read more
Source§

unsafe fn get<'a>(ptr: *const u8) -> &'a T

Get a reference to the key from the given memory location. Read more
Source§

unsafe fn drop_in_place(ptr: *mut u8)

Drop the key in place. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Print for T
where T: Display,

Source§

fn print(&self)
where Self: Display,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToCompactString for T
where T: Display,

Source§

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

Source§

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

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>,

Source§

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.