Skip to main content

BitArray

Struct BitArray 

Source
pub struct BitArray<'a>(/* private fields */);
Expand description

A run of booleans stored one byte per element.

The wire form is one byte per boolean. Only the separate flag bundles are bit-packed.

Implementations§

Source§

impl<'a> BitArray<'a>

Source

pub const fn from_bytes(bytes: &'a [u8]) -> Self

Borrow the raw bytes.

Source

pub const fn from_vec(bytes: Vec<u8>) -> Self

Take ownership of the raw bytes, one per boolean.

Source

pub fn len(&self) -> usize

Number of booleans.

Source

pub fn is_empty(&self) -> bool

Whether there are no booleans.

Source

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

The boolean at index, or None if out of range.

Source

pub fn iter(&self) -> impl Iterator<Item = bool> + '_

Iterate the booleans.

Source

pub fn as_bytes(&self) -> &[u8] ⓘ

The underlying bytes.

Source

pub fn into_owned(self) -> BitArray<'static>

Detach from the input buffer.

Trait Implementations§

Source§

impl<'a> Clone for BitArray<'a>

Source§

fn clone(&self) -> Self

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<'a> Debug for BitArray<'a>

Source§

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

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

impl<'a> Default for BitArray<'a>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'a> Eq for BitArray<'a>

Source§

impl IntoOwned for BitArray<'_>

Source§

type Owned = BitArray<'static>

The same shape, owning its data.
Source§

fn into_owned(self) -> BitArray<'static>

Copy anything still borrowed, so the result outlives the input buffer.
Source§

impl<'a> LcfField<'a> for BitArray<'a>

Source§

fn field_default(_engine: Engine) -> Self

The value this field holds when its chunk is absent and the schema gives no explicit default. Read more
Source§

fn read( data: &'a [u8], _ctx: &mut Ctx<'_>, _owner: &'static str, _id: u32, ) -> Self

Decode from a chunk payload sliced to exactly this field’s bytes. Read more
Source§

fn lcf_size(&self, _engine: Engine) -> u32

Encoded length in bytes, which the two-pass writer emits as the chunk’s length prefix.
Source§

fn element_count(&self) -> u32

Number of elements, for array-like fields. Read more
Source§

fn write<S: Sink>(&self, sink: &mut S, _engine: Engine) -> Result<(), S::Error>

Append the encoded payload. Read more
Source§

fn lcf_differs(&self, other: &Self) -> bool
where Self: PartialEq,

Whether self differs from other in its written form; the writer elides a field equal to its default. Plain !=, except floats compare by bits: -0.0 == 0.0, so != would drop a stored -0.0 and break the round trip.
Source§

impl<'a> PartialEq for BitArray<'a>

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for BitArray<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for BitArray<'a>

§

impl<'a> RefUnwindSafe for BitArray<'a>

§

impl<'a> Send for BitArray<'a>

§

impl<'a> Sync for BitArray<'a>

§

impl<'a> Unpin for BitArray<'a>

§

impl<'a> UnsafeUnpin for BitArray<'a>

§

impl<'a> UnwindSafe for BitArray<'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> 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> 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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.