Struct FixedBitSet

pub struct FixedBitSet<const N: usize>
where
    [u8; { _ }]: Sized,
{ /* private fields */ }

A compact fixed-size array of bits.

The N is the number of bits reserved for the bitset. You’re encouraged to use it like FixedBitSet<20> if you need 20 bits.

Note that this is optimized for fast serialization and deserialization for Minecraft, and may not be as performant as it could be for other purposes. Notably, the internal representation is an array of u8s even though usize would be slightly faster.

Implementations

impl<const N: usize> FixedBitSet<N>

where [u8; { _ }]: Sized,

pub const fn new() -> Self

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

pub fn set(&mut self, bit_index: usize)

Trait Implementations

impl<const N: usize> AzaleaRead for FixedBitSet<N>

where [u8; { _ }]: Sized,

fn azalea_read(buf: &mut Cursor<&[u8]>) -> Result<Self, BufReadError>

impl<const N: usize> AzaleaWrite for FixedBitSet<N>

where [u8; { _ }]: Sized,

fn azalea_write(&self, buf: &mut impl Write) -> Result<()>

impl<const N: usize> Clone for FixedBitSet<N>

where [u8; { _ }]: Sized,

fn clone(&self) -> FixedBitSet<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for FixedBitSet<N>

where [u8; { _ }]: Sized,

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

Formats the value using the given formatter.

impl<const N: usize> Default for FixedBitSet<N>

where [u8; { _ }]: Sized,

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> Hash for FixedBitSet<N>

where [u8; { _ }]: Sized,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const N: usize> PartialEq for FixedBitSet<N>

where [u8; { _ }]: Sized,

fn eq(&self, other: &FixedBitSet<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const N: usize> Eq for FixedBitSet<N>

where [u8; { _ }]: Sized,

impl<const N: usize> StructuralPartialEq for FixedBitSet<N>

where [u8; { _ }]: Sized,