arrow_buffer::bit_chunk_iterator

Struct BitChunks

Source
pub struct BitChunks<'a> { /* private fields */ }
Expand description

Iterates over an arbitrarily aligned byte buffer

Yields an iterator of u64, and a remainder. The first byte in the buffer will be the least significant byte in output u64

Implementations§

Source§

impl<'a> BitChunks<'a>

Source

pub fn new(buffer: &'a [u8], offset: usize, len: usize) -> Self

Source§

impl<'a> BitChunks<'a>

Source

pub const fn remainder_len(&self) -> usize

Returns the number of remaining bits, guaranteed to be between 0 and 63 (inclusive)

Source

pub const fn chunk_len(&self) -> usize

Returns the number of chunks

Source

pub fn remainder_bits(&self) -> u64

Returns the bitmask of remaining bits

Source

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

Returns an iterator over chunks of 64 bits represented as an u64

Source

pub fn iter_padded(&self) -> impl Iterator<Item = u64> + 'a

Returns an iterator over chunks of 64 bits, with the remaining bits zero padded to 64-bits

Trait Implementations§

Source§

impl<'a> Debug for BitChunks<'a>

Source§

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

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

impl<'a> IntoIterator for BitChunks<'a>

Source§

type Item = u64

The type of the elements being iterated over.
Source§

type IntoIter = BitChunkIterator<'a>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for BitChunks<'a>

§

impl<'a> RefUnwindSafe for BitChunks<'a>

§

impl<'a> Send for BitChunks<'a>

§

impl<'a> Sync for BitChunks<'a>

§

impl<'a> Unpin for BitChunks<'a>

§

impl<'a> UnwindSafe for BitChunks<'a>

Blanket Implementations§

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<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, 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.
Source§

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