Struct boolvec::RefBoolMut

pub struct RefBoolMut<'s> { /* fields omitted */ }

A mutable reference to a bool value that may be in the middle of a byte.

Implementations

impl<'s> RefBoolMut<'s>

pub fn new(byte: &'s mut u8, bit_mask: Mask) -> Self

Creates a new MutBool.

pub fn get(&self) -> bool

Gets the value of the referenced boolean.

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

Sets the value of the referenced boolean.

pub unsafe fn unconstrained_next_bit(self) -> Self

Returns a reference that points to the next bit without being constrained by the referenced byte.

Safety

The previous bit must be a valid value.

pub unsafe fn unconstrained_prev_bit(self) -> Self

Returns a reference that points to the previous bit without being constrained by the referenced byte.

Safety

The previous bit must be a valid value.

pub fn next_bit(self) -> Self

Returns a reference that points to the next bit within the referenced byte.

Panics

This function panics if the previous bit is not part of the referenced byte.

pub fn prev_bit(self) -> Self

Returns a reference that points to the previous bit within the referenced byte.

Panics

This function panics if the previous bit is not part of the referenced byte.

Trait Implementations

impl<'s> Clone for RefBoolMut<'s>

fn clone(&self) -> RefBoolMut<'s>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'s> Copy for RefBoolMut<'s>

impl<'s> Debug for RefBoolMut<'s>

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

Formats the value using the given formatter.

impl<'s> Display for RefBoolMut<'s>

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

Formats the value using the given formatter.

impl<'s> Eq for RefBoolMut<'s>

impl<'s> Ord for RefBoolMut<'s>

fn cmp(&self, other: &RefBoolMut<'s>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'s> PartialEq<RefBoolMut<'s>> for RefBoolMut<'s>

fn eq(&self, other: &RefBoolMut<'s>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RefBoolMut<'s>) -> bool

This method tests for !=.

impl<'s> PartialOrd<RefBoolMut<'s>> for RefBoolMut<'s>

fn partial_cmp(&self, other: &RefBoolMut<'s>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &RefBoolMut<'s>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &RefBoolMut<'s>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &RefBoolMut<'s>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &RefBoolMut<'s>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'s> StructuralEq for RefBoolMut<'s>

impl<'s> StructuralPartialEq for RefBoolMut<'s>