Struct BitPtrMut 

pub struct BitPtrMut { /* private fields */ }

A mutable pointer to a bit in memory.

Analagous to *mut T.

Implementations

impl BitPtrMut

pub const fn new(byte: *mut u8, subbyte_bit: SubByte) -> Self

Create a new raw bit pointer from a raw byte pointer and a sub-byte bit offset.

pub const fn new_on_byte(byte: *mut u8) -> Self

Create a new raw bit pointer from a raw byte pointer and zero bit offset.

pub const unsafe fn new_with_offset(byte: *mut u8, bit_count: isize) -> Self

Create a new raw bit pointer from a raw byte pointer and a bit offset.

Safety

new_with_offset has the same safety concerns as (*const _)::offset.

impl BitPtrMut

pub const fn floor_byte(&self) -> *mut u8

Returns the raw byte pointer, rounded down.

pub const fn subbyte_bit(&self) -> SubByte

Returns the sub-byte bit offset of this raw bit pointer.

pub const fn as_inner(&self) -> (*mut u8, SubByte)

Returns the raw byte pointer (rounded down) and sub-byte bit offset of this raw bit pointer.

impl BitPtrMut

pub const unsafe fn byte_offset(self, count: isize) -> Self

Adds a signed offset in bytes to a bit pointer.

count is in a unit of bytes.

Analagous to (*const _)::byte_offset.

pub const unsafe fn bit_offset(self, count: isize) -> Self

Adds a signed offset in bits to a bit pointer.

count is in a unit of bits.

Analagous to (*const _)::byte_offset.

pub const fn wrapping_byte_offset(self, count: isize) -> Self

Adds a signed offset in bytes to a bit pointer using wrapping arithmetic.

count is in a unit of bytes.

Analagous to (*const _)::wrapping_byte_offset.

impl BitPtrMut

pub const unsafe fn read(self) -> bool

Reads the bit that is pointed to.

Safety

Behaviour is undefined if self.floor_byte() is not valid for reads.

impl BitPtrMut

pub fn as_const(self) -> BitPtr

Convert to a BitPtr with the same byte and bit offset.

pub const unsafe fn write(self, bit: bool)

Sets the bit that is pointed to.

Safety

Behaviour is undefined if self.floor_byte() is not valid for writes.

Trait Implementations

impl Clone for BitPtrMut

fn clone(&self) -> BitPtrMut

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Hash for BitPtrMut

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 Ord for BitPtrMut

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BitPtrMut

fn eq(&self, other: &BitPtrMut) -> 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 PartialOrd for BitPtrMut

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for BitPtrMut

impl Eq for BitPtrMut

impl StructuralPartialEq for BitPtrMut