Struct bitworks::bit::BitRef

pub struct BitRef<'a, T: Bitset + 'a>(/* private fields */);

Smart pointer granting immutable access to a bit in Bitset.

Is not meant to be created manually, instead use methods defined on Bitset to get a value of this type. This type isn’t magic, it actually holds the Bit value.

Examples

use bitworks::prelude::*;

let bitset = Bitset8::NONE.set(1.try_into()?).build();

assert_eq!(*bitset.bit_ref(0.try_into()?), Zero);
assert_eq!(*bitset.bit_ref(1.try_into()?), One);

Implementations

impl<'a, T> BitRef<'a, T>

where T: Bitset + 'a, Self: 'a,

pub fn new(value: Bit, index: Index<T>, owner: &'a T) -> Self

Constructs a new value of BitRef

pub fn index(bit_ref: &'a Self) -> Index<T>

Returns index of the bit, referenced by BitRef.

Trait Implementations

impl<'a, T> AsRef<Bit> for BitRef<'a, T>

where T: Bitset + 'a, Self: 'a,

fn as_ref(&self) -> &Bit

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a, T> Clone for BitRef<'a, T>

where T: Bitset + 'a, Self: 'a,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> Debug for BitRef<'a, T>

where T: Bitset + 'a, Self: 'a,

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

Formats the value using the given formatter.

impl<'a, T> Deref for BitRef<'a, T>

where T: Bitset + 'a, Self: 'a,

type Target = Bit

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T> Display for BitRef<'a, T>

where T: Bitset + 'a, Self: 'a,

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

Formats the value using the given formatter.

impl<'a, T: PartialEq + Bitset + 'a> PartialEq for BitRef<'a, T>

fn eq(&self, other: &BitRef<'a, T>) -> 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<'a, T> Copy for BitRef<'a, T>

where T: Bitset + 'a,

impl<'a, T: Eq + Bitset + 'a> Eq for BitRef<'a, T>

impl<'a, T: Bitset + 'a> StructuralPartialEq for BitRef<'a, T>