Struct bitvec::slice::BitGuard

pub struct BitGuard<'a, C, T> where
    C: Cursor,
    T: 'a + BitStore,  { /* fields omitted */ }

Write reference to a single bit.

Rust requires that DerefMut produce the plain address of a value which can be written with a memcpy, so, there is no way to make plain write assignments work nicely in Rust. This reference structure is the second best option.

It contains a write reference to a single-bit slice, and a local cache bool. This structure Derefs to the local cache, and commits the cache to the slice on drop. This allows writing to the guard with = assignment.

Trait Implementations

impl<'a, C, T> Send for BitGuard<'a, C, T> where
    C: Cursor,
    T: 'a + BitStore, 

This type is a mutable reference with extra steps, so, it should be moveable but not shareable.

impl<'a, C, T> Drop for BitGuard<'a, C, T> where
    C: Cursor,
    T: 'a + BitStore, 

Commit the local cache to the backing slice.

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, C: Debug, T: Debug> Debug for BitGuard<'a, C, T> where
    C: Cursor,
    T: 'a + BitStore, 

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

Formats the value using the given formatter.

impl<'a, C, T> Deref for BitGuard<'a, C, T> where
    C: Cursor,
    T: 'a + BitStore, 

Read from the local cache.

type Target = bool

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, C, T> DerefMut for BitGuard<'a, C, T> where
    C: Cursor,
    T: 'a + BitStore, 

Write to the local cache.

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.