Struct arrow_buffer::buffer::NullBuffer

pub struct NullBuffer { /* private fields */ }

Implementations

impl NullBuffer

pub fn new(buffer: BooleanBuffer) -> Self

Create a new NullBuffer computing the null count

pub fn new_null(len: usize) -> Self

Create a new NullBuffer of length len where all values are null

pub unsafe fn new_unchecked(buffer: BooleanBuffer, null_count: usize) -> Self

Create a new NullBuffer with the provided buffer and null_count

Safety

buffer must contain null_count 0 bits

pub fn len(&self) -> usize

Returns the length of this NullBuffer

pub fn offset(&self) -> usize

Returns the offset of this NullBuffer in bits

pub fn is_empty(&self) -> bool

Returns true if this NullBuffer is empty

pub fn null_count(&self) -> usize

Returns the null count for this NullBuffer

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

Returns true if the value at idx is not null

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

Returns true if the value at idx is null

pub fn validity(&self) -> &[u8]

Returns the packed validity of this NullBuffer not including any offset

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

Slices this NullBuffer by the provided offset and length

pub fn inner(&self) -> &BooleanBuffer

Returns the inner BooleanBuffer

pub fn buffer(&self) -> &Buffer

Returns the underlying Buffer

Trait Implementations

impl Clone for NullBuffer

fn clone(&self) -> NullBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NullBuffer

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

Formats the value using the given formatter.

impl PartialEq<NullBuffer> for NullBuffer

fn eq(&self, other: &NullBuffer) -> 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.

impl Eq for NullBuffer

impl StructuralEq for NullBuffer

impl StructuralPartialEq for NullBuffer