Struct canadensis_data_types::bits::BitArray

pub struct BitArray<const BYTES: usize> { /* fields omitted */ }

An array of bits in a format compatible with UAVCAN serialization

Because the const generics feature is incomplete, the integer generic parameter is a number of bytes (= 8 bits), not a number of bits. The functions still use bit indexes.

Implementations

impl<const BYTES: usize> BitArray<BYTES>

pub fn new(bit_length: usize) -> Self

Creates a bit set with all bits set to zero

pub fn len(&self) -> usize

Returns the number of bits in this array

pub fn is_empty(&self) -> bool

Returns true if this array is empty

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

Returns the value of a bit at the provided bit index

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

Sets the value of a bit at the provided bit index

pub fn fill(&mut self, value: bool)

Sets all bits in this array to the specified value

pub fn serialize(&self, cursor: &mut WriteCursor<'_>)

Serializes this bit set (not including the length)

Note: This type doesn’t implement DataType, Serialize, or Deserialize because it is not a composite type and has an alignment of only 1 bit.

pub fn deserialize_in_place(&mut self, cursor: &mut ReadCursor<'_>)

Deserializes this bit set (not including the length). self.bit_length must be set before this function is called.

pub fn deserialize(bit_length: usize, cursor: &mut ReadCursor<'_>) -> Self

Trait Implementations

impl<const BYTES: usize> Clone for BitArray<BYTES>

fn clone(&self) -> BitArray<BYTES>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const BYTES: usize> Debug for BitArray<BYTES>

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

Formats the value using the given formatter.

impl<const BYTES: usize> PartialEq<BitArray<BYTES>> for BitArray<BYTES>

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 !=.