#[repr(transparent)]pub struct BitIdx<R = usize> where
R: BitRegister, { /* private fields */ }Expand description
Semantic Bit Index
This type is a counter in the ring 0 .. R::BITS and serves to mark a semantic
index within some register element. It is a virtual index, and is the stored
value used in pointer encodings to track region start information.
It is translated to a real index through the BitOrder trait. This virtual
index is the only counter that can be used for address computation, and once
lowered to an electrical index through BitOrder::at, the electrical address
can only be used for setting up machine instructions.
Type Parameters
R: The register element that this index governs.
Validity
Values of this type are required to be in the range 0 .. R::BITS. Any
value not less than R::BITS makes the program invalid, and will likely cause
either a crash or incorrect memory access.
Construction
This type can never be constructed outside of the bitvec crate. It is passed
in to BitOrder implementations, which may use it to construct electrical
position values from it. All values of this type constructed by bitvec are
known to be correct in their region; no other construction site can be trusted.
Implementations
sourceimpl<R> BitIdx<R> where
R: BitRegister,
impl<R> BitIdx<R> where
R: BitRegister,
sourcepub fn new(idx: u8) -> Result<Self, BitIdxError<R>>
pub fn new(idx: u8) -> Result<Self, BitIdxError<R>>
Wraps a counter value as a known-good index into an R register.
Parameters
idx: The counter value to mark as an index. This must be in the range0 .. R::BITS.
Returns
This returns idx, either marked as a valid BitIdx or an invalid
BitIdxError by whether it is within the valid range 0 .. R::BITS.
sourcepub unsafe fn new_unchecked(idx: u8) -> Self
pub unsafe fn new_unchecked(idx: u8) -> Self
Wraps a counter value as an assumed-good index into an R register.
Parameters
idx: The counter value to mark as an index. This must be in the range0 .. R::BITS.
Returns
This unconditionally marks idx as a valid bit-index.
Safety
If the idx value is outside the valid range, then the program is
incorrect. Debug builds will panic; release builds do not inspect the
value or specify a behavior.
sourcepub fn into_inner(self) -> u8
pub fn into_inner(self) -> u8
Removes the index wrapper, leaving the internal counter.
sourcepub fn next(self) -> (Self, bool)
pub fn next(self) -> (Self, bool)
Increments an index counter, wrapping at the back edge of the register.
Parameters
self: The index to increment.
Returns
.0: The next index afterself..1: Indicates whether the new index is in the next memory address.
sourcepub fn prev(self) -> (Self, bool)
pub fn prev(self) -> (Self, bool)
Decrements an index counter, wrapping at the front edge of the register.
Parameters
self: The index to decrement.
Returns
.0: The previous index beforeself..1: Indicates whether the new index is in the previous memory address.
sourcepub fn position<O>(self) -> BitPos<R> where
O: BitOrder,
pub fn position<O>(self) -> BitPos<R> where
O: BitOrder,
Computes the bit position corresponding to self under some ordering.
This forwards to O::at::<R>, which is the only public, safe,
constructor for a position counter.
sourcepub fn select<O>(self) -> BitSel<R> where
O: BitOrder,
pub fn select<O>(self) -> BitSel<R> where
O: BitOrder,
Computes the bit selector corresponding to self under an ordering.
This forwards to O::select::<R>, which is the only public, safe,
constructor for a bit selector.
sourcepub fn mask<O>(self) -> BitMask<R> where
O: BitOrder,
pub fn mask<O>(self) -> BitMask<R> where
O: BitOrder,
Computes the bit selector for self as an accessor mask.
This is a type-cast over Self::select.
sourcepub fn range(
self,
upto: BitEnd<R>
) -> impl Iterator<Item = Self> + DoubleEndedIterator + ExactSizeIterator + FusedIterator
pub fn range(
self,
upto: BitEnd<R>
) -> impl Iterator<Item = Self> + DoubleEndedIterator + ExactSizeIterator + FusedIterator
Iterates over all indices between an inclusive start and exclusive end point.
Because implementation details of the range type family, including the
RangeBounds trait, are not yet stable, and heterogeneous ranges are
not supported, this must be an opaque iterator rather than a direct
Range<BitIdx<R>>.
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.
sourcepub fn range_all(
) -> impl Iterator<Item = Self> + DoubleEndedIterator + ExactSizeIterator + FusedIterator
pub fn range_all(
) -> impl Iterator<Item = Self> + DoubleEndedIterator + ExactSizeIterator + FusedIterator
Iterates over all possible index values.
Trait Implementations
sourceimpl<R> Binary for BitIdx<R> where
R: BitRegister,
impl<R> Binary for BitIdx<R> where
R: BitRegister,
sourceimpl<R: Clone> Clone for BitIdx<R> where
R: BitRegister,
impl<R: Clone> Clone for BitIdx<R> where
R: BitRegister,
sourceimpl<R> Debug for BitIdx<R> where
R: BitRegister,
impl<R> Debug for BitIdx<R> where
R: BitRegister,
sourceimpl<R: Default> Default for BitIdx<R> where
R: BitRegister,
impl<R: Default> Default for BitIdx<R> where
R: BitRegister,
sourceimpl<'de, R> Deserialize<'de> for BitIdx<R> where
R: BitRegister,
impl<'de, R> Deserialize<'de> for BitIdx<R> where
R: BitRegister,
sourcefn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl<R> Display for BitIdx<R> where
R: BitRegister,
impl<R> Display for BitIdx<R> where
R: BitRegister,
sourceimpl<R: Hash> Hash for BitIdx<R> where
R: BitRegister,
impl<R: Hash> Hash for BitIdx<R> where
R: BitRegister,
sourceimpl<R: Ord> Ord for BitIdx<R> where
R: BitRegister,
impl<R: Ord> Ord for BitIdx<R> where
R: BitRegister,
sourceimpl<R: PartialOrd> PartialOrd<BitIdx<R>> for BitIdx<R> where
R: BitRegister,
impl<R: PartialOrd> PartialOrd<BitIdx<R>> for BitIdx<R> where
R: BitRegister,
sourcefn partial_cmp(&self, other: &BitIdx<R>) -> Option<Ordering>
fn partial_cmp(&self, other: &BitIdx<R>) -> Option<Ordering>
This method returns an ordering between self and other values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more
sourceimpl<R> Serialize for BitIdx<R> where
R: BitRegister,
impl<R> Serialize for BitIdx<R> where
R: BitRegister,
sourcefn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl<R: Copy> Copy for BitIdx<R> where
R: BitRegister,
impl<R: Eq> Eq for BitIdx<R> where
R: BitRegister,
impl<R> StructuralEq for BitIdx<R> where
R: BitRegister,
impl<R> StructuralPartialEq for BitIdx<R> where
R: BitRegister,
Auto Trait Implementations
impl<R> RefUnwindSafe for BitIdx<R> where
R: RefUnwindSafe,
impl<R> Send for BitIdx<R>
impl<R> Sync for BitIdx<R>
impl<R> Unpin for BitIdx<R>
impl<R> UnwindSafe for BitIdx<R> where
R: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> FmtForward for T
impl<T> FmtForward for T
sourcefn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
Causes self to use its Binary implementation when Debug-formatted. Read more
sourcefn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
Causes self to use its Display implementation when
Debug-formatted. Read more
sourcefn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
Causes self to use its LowerExp implementation when
Debug-formatted. Read more
sourcefn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
Causes self to use its LowerHex implementation when
Debug-formatted. Read more
sourcefn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,
Causes self to use its Octal implementation when Debug-formatted. Read more
sourcefn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
Causes self to use its Pointer implementation when
Debug-formatted. Read more
sourcefn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
Causes self to use its UpperExp implementation when
Debug-formatted. Read more
sourcefn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
Causes self to use its UpperHex implementation when
Debug-formatted. Read more
sourceimpl<T> Pipe for T where
T: ?Sized,
impl<T> Pipe for T where
T: ?Sized,
sourcefn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
Pipes by value. This is generally the method you want to use. Read more
sourcefn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,
Borrows self and passes that borrow into the pipe function. Read more
sourcefn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more
sourcefn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
Borrows self, then passes self.borrow() into the pipe function. Read more
sourcefn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
Mutably borrows self, then passes self.borrow_mut() into the pipe
function. Read more
sourcefn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
Borrows self, then passes self.as_ref() into the pipe function.
sourcefn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
Mutably borrows self, then passes self.as_mut() into the pipe
function. Read more
sourceimpl<T> Tap for T
impl<T> Tap for T
sourcefn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Immutable access to the Borrow<B> of a value. Read more
sourcefn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Mutable access to the BorrowMut<B> of a value. Read more
sourcefn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
Immutable access to the AsRef<R> view of a value. Read more
sourcefn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Mutable access to the AsMut<R> view of a value. Read more
sourcefn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,
Immutable access to the Deref::Target of a value. Read more
sourcefn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Mutable access to the Deref::Target of a value. Read more
sourcefn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.
sourcefn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
builds. Read more
sourcefn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Calls .tap_borrow() only in debug builds, and is erased in release
builds. Read more
sourcefn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Calls .tap_borrow_mut() only in debug builds, and is erased in release
builds. Read more
sourcefn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
Calls .tap_ref() only in debug builds, and is erased in release
builds. Read more
sourcefn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Calls .tap_ref_mut() only in debug builds, and is erased in release
builds. Read more