Struct bitvec::index::BitIdx [−][src]
#[repr(transparent)]pub struct BitIdx<R = usize> where
R: BitRegister, { /* fields omitted */ }
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
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
.
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.
Removes the index wrapper, leaving the internal counter.
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.
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.
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.
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.
Computes the bit selector for self
as an accessor mask.
This is a type-cast over Self::select
.
pub 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
.
pub 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
Deserialize this value from the given Serde deserializer. Read more
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
fn 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
Auto Trait Implementations
impl<R> RefUnwindSafe for BitIdx<R> where
R: RefUnwindSafe,
impl<R> UnwindSafe for BitIdx<R> where
R: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Causes self
to use its Binary
implementation when Debug
-formatted. Read more
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. Read more
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
Pipes by value. This is generally the method you want to use. Read more
Borrows self
and passes that borrow into the pipe function. Read more
Mutably borrows self
and passes that borrow into the pipe function. Read more
Borrows self
, then passes self.borrow()
into the pipe function. Read more
Mutably borrows self
, then passes self.borrow_mut()
into the pipe
function. Read more
Borrows self
, then passes self.as_ref()
into the pipe function.
Mutably borrows self
, then passes self.as_mut()
into the pipe
function. Read more
Borrows self
, then passes self.deref()
into the pipe function.
Immutable access to the Borrow<B>
of a value. Read more
Mutable access to the BorrowMut<B>
of a value. Read more
Immutable access to the AsRef<R>
view of a value. Read more
Mutable access to the AsMut<R>
view of a value. Read more
Immutable access to the Deref::Target
of a value. Read more
Mutable access to the Deref::Target
of a value. Read more
Calls .tap()
only in debug builds, and is erased in release builds.
Calls .tap_mut()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_borrow()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_borrow_mut()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_ref()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_ref_mut()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_deref()
only in debug builds, and is erased in release
builds. Read more