Struct BitIdxError

#[repr(transparent)]
pub struct BitIdxError<R = usize>
where
    R: BitRegister,
{
    err: u8,
    _ty: PhantomData<R>,
}

Bit Index Error

This type marks that a value is out of range to be used as an index within an R element. It is likely never produced, as bitvec does not construct invalid indices, but is provided for completeness and to ensure that in the event of this error occurring, the diagnostic information is useful.

Fields

err: u8

_ty: PhantomData<R>

Implementations

impl<R> BitIdxError<R>

where R: BitRegister,

pub fn into_inner(self) -> u8

Available on non-tarpaulin_include only.

Removes the error wrapper, leaving the internal counter.

Trait Implementations

impl<R> Clone for BitIdxError<R>

where R: Clone + BitRegister,

fn clone(&self) -> BitIdxError<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R> Debug for BitIdxError<R>

where R: BitRegister,

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<R> Default for BitIdxError<R>

where R: Default + BitRegister,

fn default() -> BitIdxError<R>

Returns the “default value” for a type.

impl<R> Display for BitIdxError<R>

where R: BitRegister,

Available on non-tarpaulin_include only.

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<R> Error for BitIdxError<R>

where R: BitRegister,

Available on crate feature std only.

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<R> Hash for BitIdxError<R>

where R: Hash + BitRegister,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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<R> Ord for BitIdxError<R>

where R: Ord + BitRegister,

fn cmp(&self, other: &BitIdxError<R>) -> 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<R> PartialEq for BitIdxError<R>

where R: PartialEq + BitRegister,

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

where R: PartialOrd + BitRegister,

fn partial_cmp(&self, other: &BitIdxError<R>) -> 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<R> Copy for BitIdxError<R>

where R: Copy + BitRegister,

impl<R> Eq for BitIdxError<R>

where R: Eq + BitRegister,

impl<R> StructuralPartialEq for BitIdxError<R>

where R: BitRegister,

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1 byte