Struct arrow2::bitmap::Bitmap

pub struct Bitmap { /* private fields */ }

An immutable container whose API is optimized to handle bitmaps. All quantities on this container’s API are measured in bits.

Implementation

• memory on this container is sharable across thread boundaries
• Cloning Bitmap is O(1)
• Slicing Bitmap is O(1)

Implementations

impl Bitmap

pub fn new() -> Self

Initializes an empty Bitmap.

pub fn new_zeroed(length: usize) -> Self

Initializes an new Bitmap filled with unset values.

pub fn len(&self) -> usize

Returns the length of the Bitmap.

pub fn is_empty(&self) -> bool

Returns whether Bitmap is empty

pub fn from_u8_vec(vec: Vec<u8>, length: usize) -> Self

Creates a new Bitmap from Vec and a length. This function is O(1)

Panic

Panics iff length <= buffer.len() * 8

pub fn from_u8_slice<T: AsRef<[u8]>>(buffer: T, length: usize) -> Self

Creates a new Bitmap from a slice and length.

Panic

Panics iff length <= bytes.len() * 8

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

Counts the nulls (unset bits) starting from offset bits and for length bits.

pub fn null_count(&self) -> usize

Returns the number of unset bits on this Bitmap.

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

Slices self, offsetting by offset and truncating up to length bits.

Panic

Panics iff self.offset + offset + length >= self.bytes.len() * 8, i.e. if the offset and length exceeds the allocated capacity of self.

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

Slices self, offseting by offset and truncating up to length bits.

Safety

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

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

Returns whether the bit at position i is set.

Panics

Panics iff i >= self.len().

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

Returns whether the bit at position i is set.

pub unsafe fn get_bit_unchecked(&self, i: usize) -> bool

Unsafely returns whether the bit at position i is set.

Safety

Unsound iff i >= self.len().

pub fn into_mut(self) -> Either<Self, MutableBitmap>

Converts this Bitmap to MutableBitmap, returning itself if the conversion is not possible

This operation returns a MutableBitmap iff:

• this Bitmap is not an offsetted slice of another Bitmap
• this Bitmap has not been cloned (i.e. Arc::get_mut yields Some)
• this Bitmap was not imported from the c data interface (FFI)

impl Bitmap

pub fn chunks<T: BitChunk>(&self) -> BitChunks<'_, T>

Returns an iterator over bits in chunks of T, which is useful for bit operations.

impl Bitmap

pub unsafe fn from_trusted_len_iter_unchecked<I: Iterator<Item = bool>>(
    iterator: I
) -> Self

Creates a new Bitmap from an iterator of booleans.

Safety

The iterator must report an accurate length.

pub fn from_trusted_len_iter<I: TrustedLen<Item = bool>>(iterator: I) -> Self

Creates a new Bitmap from an iterator of booleans.

pub fn try_from_trusted_len_iter<E, I: TrustedLen<Item = Result<bool, E>>>(
    iterator: I
) -> Result<Self, E>

Creates a new Bitmap from a fallible iterator of booleans.

pub unsafe fn try_from_trusted_len_iter_unchecked<E, I: Iterator<Item = Result<bool, E>>>(
    iterator: I
) -> Result<Self, E>

Creates a new Bitmap from a fallible iterator of booleans.

Safety

The iterator must report an accurate length.

impl Bitmap

pub fn as_slice(&self) -> (&[u8], usize, usize)

Returns the byte slice of this Bitmap.

The returned tuple contains: .1 -> The byte slice, truncated to the start of the first bit. So the start of the slice is within the first 8 bits. .2 -> The start offset in bits, given what described above 0 <= offsets < 8. .3 -> The length in bits.

impl<'a> Bitmap

pub fn iter(&'a self) -> BitmapIter<'a>

constructs a new iterator

Trait Implementations

impl<'a, 'b> BitAnd<&'b Bitmap> for &'a Bitmap

type Output = Bitmap

The resulting type after applying the & operator.

fn bitand(self, rhs: &'b Bitmap) -> Bitmap

Performs the & operation.

impl<'a, 'b> BitOr<&'b Bitmap> for &'a Bitmap

type Output = Bitmap

The resulting type after applying the | operator.

fn bitor(self, rhs: &'b Bitmap) -> Bitmap

Performs the | operation.

impl<'a, 'b> BitXor<&'b Bitmap> for &'a Bitmap

type Output = Bitmap

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'b Bitmap) -> Bitmap

Performs the ^ operation.

impl Clone for Bitmap

fn clone(&self) -> Bitmap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bitmap

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

Formats the value using the given formatter.

impl Default for Bitmap

fn default() -> Self

Returns the “default value” for a type.

impl From<MutableBitmap> for Bitmap

fn from(buffer: MutableBitmap) -> Self

Performs the conversion.

impl<P: AsRef<[bool]>> From<P> for Bitmap

fn from(slice: P) -> Self

Performs the conversion.

impl FromIterator<bool> for Bitmap

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = bool>, 

Creates a value from an iterator.

impl<'a> IntoIterator for &'a Bitmap

type Item = bool

The type of the elements being iterated over.

type IntoIter = BitmapIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Not for &Bitmap

type Output = Bitmap

The resulting type after applying the ! operator.

fn not(self) -> Bitmap

Performs the unary ! operation.

impl PartialEq<Bitmap> for Bitmap

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 !=.