#[repr(transparent)]pub struct BitIdx<M> where
M: BitMemory, { /* private fields */ }
Expand description
A semantic index of a single bit within a memory element M
.
This type is a counter in the range 0 .. M::BITS
, and marks the semantic
position of a bit according to some BitOrder
implementation. As an abstract
counter, it can be used in arithmetic without having to go through BitOrder
translation to an electrical position.
Type Parameters
M
: The register type that values of this type govern.
Validity
Values of this type are required to be in the range 0 .. M::BITS
. Any value
outside this range will cause the program state to become invalid, and the
library’s behavior is unspecified. The library will never produce such an
invalid value.
Construction
This type cannot be constructed outside the bitvec
crate. bitvec
will
construct safe values of this type, and allows users to view them and use them
to construct other index types from them. All values of this type constructed by
bitvec
are known to be correct based on user input to the crate.
Implementations
Computes the bit position corresponding to self
under some ordering.
This forwards to O::at::<M>
, and is the only public, safe, constructor
for a position counter.
Computes the bit selector corresponding to self
under an ordering.
This forwards to O::select::<M>
, and is the only public, safe,
constructor for a bit selector.
Computes the bit selector for self
as an accessor mask.
This is a type-cast over Self::select
. It is one of the few public,
safe, constructors of a multi-bit mask.
pub fn range(
from: Self,
upto: BitTail<M>
) -> impl Iterator<Item = Self> + DoubleEndedIterator + ExactSizeIterator + FusedIterator
pub fn range(
from: Self,
upto: BitTail<M>
) -> impl Iterator<Item = Self> + DoubleEndedIterator + ExactSizeIterator + FusedIterator
Constructs a range over all indices between a start and end point.
Because implementation details of the RangeOps
family are not yet
stable, and heterogenous ranges are not supported, this must be an
opaque iterator rather than a direct Range<BitIdx<M>>
.
Parameters
from
: The inclusive low bound of the range. This will be the first index produced by the iterator.upto
: The exclusive high bound of the range. The iterator will halt before yielding an index of this value.
Returns
An opaque iterator that is equivalent to the range from .. upto
.
Requirements
from
must be no greater than upto
.
Trait Implementations
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl<M> RefUnwindSafe for BitIdx<M> where
M: RefUnwindSafe,
impl<M> UnwindSafe for BitIdx<M> where
M: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Causes self
to use its Binary
implementation when Debug
-formatted.
Causes self
to use its Display
implementation when
Debug
-formatted. Read more
Causes self
to use its LowerExp
implementation when
Debug
-formatted. Read more
Causes self
to use its LowerHex
implementation when
Debug
-formatted. Read more
Causes self
to use its Octal
implementation when Debug
-formatted.
Causes self
to use its Pointer
implementation when
Debug
-formatted. Read more
Causes self
to use its UpperExp
implementation when
Debug
-formatted. Read more
Causes self
to use its UpperHex
implementation when
Debug
-formatted. Read more
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
Pipes a dereference into a function that cannot normally be called in suffix position. Read more
Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more
Provides immutable access to the reference for inspection.
Calls tap_ref
in debug builds, and does nothing in release builds.
Provides mutable access to the reference for modification.
Calls tap_ref_mut
in debug builds, and does nothing in release builds.
Provides immutable access to the borrow for inspection. Read more
Calls tap_borrow
in debug builds, and does nothing in release builds.
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Provides mutable access to the borrow for modification.
Immutably dereferences self
for inspection.
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Calls tap_deref
in debug builds, and does nothing in release builds.
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Mutably dereferences self
for modification.