Struct arrow::bitmap::Bitmap

pub struct Bitmap { /* private fields */ }

Defines a bitmap, which is used to track which values in an Arrow array are null.

This is called a “validity bitmap” in the Arrow documentation.

Implementations

impl Bitmap

pub fn new(num_bits: usize) -> Self

pub fn bit_len(&self) -> usize

Return the length of this Bitmap in bits (not bytes)

pub fn is_empty(&self) -> bool

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

pub fn buffer_ref(&self) -> &Buffer

pub fn into_buffer(self) -> Buffer

pub fn get_buffer_memory_size(&self) -> usize

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

pub fn get_array_memory_size(&self) -> usize

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

Trait Implementations

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

type Output = Result<Bitmap, ArrowError>

The resulting type after applying the & operator.

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

Performs the & operation.

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

type Output = Result<Bitmap, ArrowError>

The resulting type after applying the | operator.

fn bitor(self, rhs: &'b Bitmap) -> Result<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 From<Buffer> for Bitmap

fn from(buf: Buffer) -> Self

Converts to this type from the input type.

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.