Struct bitvec::ptr::BitPtrRange [−][src]
#[repr(C)]pub struct BitPtrRange<M = Const, T = usize, O = Lsb0> where
M: Mutability,
T: BitStore,
O: BitOrder, {
pub start: BitPtr<M, T, O>,
pub end: BitPtr<M, T, O>,
}
Expand description
Bit-Pointer Range
This type is equivalent in purpose, but superior in functionality, to
Range<BitPtr<M, T, O>>
. If the standard library stabilizes Step
, the trait
used to drive Range
operations, then this type will likely be destroyed in
favor of an impl Step for BitPtr
block and use of standard ranges.
Like Range
, this is a half-open set where the low bit-pointer selects the
first live bit in a span and the high bit-pointer selects the first dead bit
after the span.
This type is not capable of inspecting provenance, and has no requirement of its
own that both bit-pointers be derived from the same provenance region. It is
safe to construct and use with any pair of bit-pointers; however, the
bit-pointers it produces are, necessarily, unsafe
to use.
Original
Memory Representation
BitPtr
is required to be repr(packed)
in order to satisfy the BitRef
size optimizations. In order to stay minimally sized itself, this type has no
alignment requirement, and reading either bit-pointer may incur a misalignment
penalty. Reads are always safe and valid; they may merely be slow.
Type Parameters
This takes the same type parameters as BitPtr
, as it is simply a pair of
bit-pointers with range semantics.
Fields
start: BitPtr<M, T, O>
The lower, inclusive, bound of the range. The bit to which this points is considered live.
end: BitPtr<M, T, O>
The higher, exclusive, bound of the range. The bit to which this points is considered dead, and the pointer may be one bit beyond the bounds of an allocation region.
Because Rust and LLVM both define the address of base + (len * width)
as being within the provenance of base
, even though that address may
itself be the base address of another region in a different provenance,
and bit-pointers are always composed of an ordinary memory address and a
bit-counter, the ending bit-pointer is always valid.
Implementations
The canonical empty range. All ranges with zero length (equal .start
and .end
) are equally empty.
Explicitly converts a Range<BitPtr>
into a BitPtrRange
.
Explicitly converts a BitPtrRange
into a Range<BitPtr>
.
Tests if the range is empty (the distance between bit-pointers is 0
).
Original
Examples
use bitvec::prelude::*;
use bitvec::ptr::BitPtrRange;
let data = 0u8;
let bp = BitPtr::<_, _, Lsb0>::from_ref(&data);
let mut range = BitPtrRange::from_range(bp .. bp.wrapping_add(1));
assert!(!range.is_empty());
assert_ne!(range.start, range.end);
range.next();
assert!(range.is_empty());
assert_eq!(range.start, range.end);
Tests if a given bit-pointer is contained within the range.
Bit-pointer ordering is defined when the types have the same exact
BitOrder
type parameter and the same BitStore::Mem
associated type
(but are free to differ in alias condition!). Inclusion in a range
occurs when the bit-pointer is not strictly less than the range start,
and is strictly less than the range end.
Original
Examples
use bitvec::prelude::*;
use bitvec::ptr::BitPtrRange;
use core::cell::Cell;
let data = 0u16;
let bp = BitPtr::<_, _, Lsb0>::from_ref(&data);
let mut range = BitPtrRange::from_range(bp .. bp.wrapping_add(16));
range.nth(2);
range.nth_back(2);
assert!(bp < range.start);
assert!(!range.contains(&bp));
let mid = bp.wrapping_add(8);
let same_mem = mid.cast::<Cell<u16>>();
assert!(range.contains(&mid));
Casting to a different BitStore
type whose Mem
parameter differs
from the range always results in a false
response, even if the pointer
being tested is numerically within the range.
Trait Implementations
impl<M, T, O> DoubleEndedIterator for BitPtrRange<M, T, O> where
M: Mutability,
T: BitStore,
O: BitOrder,
impl<M, T, O> DoubleEndedIterator for BitPtrRange<M, T, O> where
M: Mutability,
T: BitStore,
O: BitOrder,
Removes and returns an element from the end of the iterator. Read more
Returns the n
th element from the end of the iterator. Read more
iter_advance_by
)Advances the iterator from the back by n
elements. Read more
This is the reverse version of Iterator::try_fold()
: it takes
elements starting from the back of the iterator. Read more
An iterator method that reduces the iterator’s elements to a single, final value, starting from the back. Read more
impl<M, T, O> ExactSizeIterator for BitPtrRange<M, T, O> where
M: Mutability,
T: BitStore,
O: BitOrder,
impl<M, T, O> ExactSizeIterator for BitPtrRange<M, T, O> where
M: Mutability,
T: BitStore,
O: BitOrder,
impl<M, T, O> From<BitPtrRange<M, T, O>> for Range<BitPtr<M, T, O>> where
M: Mutability,
T: BitStore,
O: BitOrder,
impl<M, T, O> From<BitPtrRange<M, T, O>> for Range<BitPtr<M, T, O>> where
M: Mutability,
T: BitStore,
O: BitOrder,
Performs the conversion.
impl<M, T, O> From<Range<BitPtr<M, T, O>>> for BitPtrRange<M, T, O> where
M: Mutability,
T: BitStore,
O: BitOrder,
impl<M, T, O> From<Range<BitPtr<M, T, O>>> for BitPtrRange<M, T, O> where
M: Mutability,
T: BitStore,
O: BitOrder,
Returns the bounds on the remaining length of the iterator. Read more
Consumes the iterator, counting the number of iterations and returning it. Read more
Consumes the iterator, returning the last element. Read more
Advances the iterator and returns the next value. Read more
Returns the n
th element of the iterator. Read more
iter_advance_by
)Advances the iterator by n
elements. Read more
Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more
1.0.0[src]fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator<Item = Self::Item>,
fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator<Item = Self::Item>,
Takes two iterators and creates a new iterator over both in sequence. Read more
1.0.0[src]fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator,
fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator,
‘Zips up’ two iterators into a single iterator of pairs. Read more
iter_intersperse
)Creates a new iterator which places a copy of separator
between adjacent
items of the original iterator. Read more
fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G> where
G: FnMut() -> Self::Item,
fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G> where
G: FnMut() -> Self::Item,
iter_intersperse
)Creates a new iterator which places an item generated by separator
between adjacent items of the original iterator. Read more
Takes a closure and creates an iterator which calls that closure on each element. Read more
Calls a closure on each element of an iterator. Read more
Creates an iterator which uses a closure to determine if an element should be yielded. Read more
Creates an iterator that both filters and maps. Read more
Creates an iterator which gives the current iteration count as well as the next value. Read more
Creates an iterator that yields elements based on a predicate. Read more
Creates an iterator that both yields elements based on a predicate and maps. Read more
Creates an iterator that skips the first n
elements. Read more
Creates an iterator that yields the first n
elements, or fewer
if the underlying iterator ends sooner. Read more
Creates an iterator that works like map, but flattens nested structure. Read more
Creates an iterator that flattens nested structure. Read more
Does something with each element of an iterator, passing the value on. Read more
Transforms an iterator into a collection. Read more
Consumes an iterator, creating two collections from it. Read more
fn partition_in_place<'a, T, P>(self, predicate: P) -> usize where
T: 'a,
Self: DoubleEndedIterator<Item = &'a mut T>,
P: FnMut(&T) -> bool,
fn partition_in_place<'a, T, P>(self, predicate: P) -> usize where
T: 'a,
Self: DoubleEndedIterator<Item = &'a mut T>,
P: FnMut(&T) -> bool,
iter_partition_in_place
)Reorders the elements of this iterator in-place according to the given predicate,
such that all those that return true
precede all those that return false
.
Returns the number of true
elements found. Read more
iter_is_partitioned
)Checks if the elements of this iterator are partitioned according to the given predicate,
such that all those that return true
precede all those that return false
. Read more
An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more
An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more
Folds every element into an accumulator by applying an operation, returning the final result. Read more
Reduces the elements to a single one, by repeatedly applying a reducing operation. Read more
iterator_try_reduce
)Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately. Read more
Tests if every element of the iterator matches a predicate. Read more
Tests if any element of the iterator matches a predicate. Read more
Searches for an element of an iterator that satisfies a predicate. Read more
Applies function to the elements of iterator and returns the first non-none result. Read more
try_find
)Applies function to the elements of iterator and returns the first true result or the first error. Read more
Searches for an element in an iterator, returning its index. Read more
1.0.0[src]fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,
Self: ExactSizeIterator + DoubleEndedIterator,
fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,
Self: ExactSizeIterator + DoubleEndedIterator,
Searches for an element in an iterator from the right, returning its index. Read more
Returns the maximum element of an iterator. Read more
Returns the minimum element of an iterator. Read more
Returns the element that gives the maximum value from the specified function. Read more
Returns the element that gives the maximum value with respect to the specified comparison function. Read more
Returns the element that gives the minimum value from the specified function. Read more
Returns the element that gives the minimum value with respect to the specified comparison function. Read more
Reverses an iterator’s direction. Read more
Converts an iterator of pairs into a pair of containers. Read more
Creates an iterator which copies all of its elements. Read more
Sums the elements of an iterator. Read more
Iterates over the entire iterator, multiplying all the elements Read more
Lexicographically compares the elements of this Iterator
with those
of another. Read more
fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,
fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,
iter_order_by
)Lexicographically compares the elements of this Iterator
with those
of another with respect to the specified comparison function. Read more
1.5.0[src]fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Lexicographically compares the elements of this Iterator
with those
of another. Read more
fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering> where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering> where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
iter_order_by
)Lexicographically compares the elements of this Iterator
with those
of another with respect to the specified comparison function. Read more
1.5.0[src]fn eq<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
fn eq<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
fn eq_by<I, F>(self, other: I, eq: F) -> bool where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,
fn eq_by<I, F>(self, other: I, eq: F) -> bool where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,
iter_order_by
)1.5.0[src]fn ne<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
fn ne<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
1.5.0[src]fn lt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
fn lt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are lexicographically
less than those of another. Read more
1.5.0[src]fn le<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
fn le<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are lexicographically
less or equal to those of another. Read more
1.5.0[src]fn gt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
fn gt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are lexicographically
greater than those of another. Read more
1.5.0[src]fn ge<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
fn ge<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are lexicographically
greater than or equal to those of another. Read more
is_sorted
)Checks if the elements of this iterator are sorted. Read more
is_sorted
)Checks if the elements of this iterator are sorted using the given comparator function. Read more
fn is_sorted_by_key<F, K>(self, f: F) -> bool where
F: FnMut(Self::Item) -> K,
K: PartialOrd<K>,
fn is_sorted_by_key<F, K>(self, f: F) -> bool where
F: FnMut(Self::Item) -> K,
K: PartialOrd<K>,
is_sorted
)Checks if the elements of this iterator are sorted using the given key extraction function. Read more
impl<M1, M2, O, T1, T2> PartialEq<BitPtrRange<M2, T2, O>> for BitPtrRange<M1, T1, O> where
M1: Mutability,
M2: Mutability,
O: BitOrder,
T1: BitStore,
T2: BitStore,
impl<M1, M2, O, T1, T2> PartialEq<BitPtrRange<M2, T2, O>> for BitPtrRange<M1, T1, O> where
M1: Mutability,
M2: Mutability,
O: BitOrder,
T1: BitStore,
T2: BitStore,
impl<M, T, O> RangeBounds<BitPtr<M, T, O>> for BitPtrRange<M, T, O> where
M: Mutability,
T: BitStore,
O: BitOrder,
impl<M, T, O> RangeBounds<BitPtr<M, T, O>> for BitPtrRange<M, T, O> where
M: Mutability,
T: BitStore,
O: BitOrder,
Start index bound. Read more
1.35.0[src]fn contains<U>(&self, item: &U) -> bool where
T: PartialOrd<U>,
U: PartialOrd<T> + ?Sized,
fn contains<U>(&self, item: &U) -> bool where
T: PartialOrd<U>,
U: PartialOrd<T> + ?Sized,
Returns true
if item
is contained in the range. Read more
impl<M, T, O> FusedIterator for BitPtrRange<M, T, O> where
M: Mutability,
T: BitStore,
O: BitOrder,
Auto Trait Implementations
impl<M, T, O> RefUnwindSafe for BitPtrRange<M, T, O> where
M: RefUnwindSafe,
O: RefUnwindSafe,
T: RefUnwindSafe,
<T as BitStore>::Mem: RefUnwindSafe,
impl<M = Const, T = usize, O = Lsb0> !Send for BitPtrRange<M, T, O>
impl<M = Const, T = usize, O = Lsb0> !Sync for BitPtrRange<M, T, O>
impl<M, T, O> Unpin for BitPtrRange<M, T, O> where
M: Unpin,
O: Unpin,
impl<M, T, O> UnwindSafe for BitPtrRange<M, T, O> where
M: UnwindSafe,
O: UnwindSafe,
T: RefUnwindSafe,
<T as BitStore>::Mem: 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