Struct bitvec::index::BitIdxError

#[repr(transparent)]pub struct BitIdxError<R> where
    R: BitRegister,  { /* fields omitted */ }

Marks an index that is invalid for a register type.

Implementations

impl<R> BitIdxError<R> where
    R: BitRegister, 

pub fn value(self) -> u8

Removes the error wrapper, leaving the internal counter.

Trait Implementations

impl<R: Clone> Clone for BitIdxError<R> where
    R: BitRegister, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Copy> Copy for BitIdxError<R> where
    R: BitRegister, 

impl<R> Debug for BitIdxError<R> where
    R: BitRegister, 

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

Formats the value using the given formatter.

impl<R: Default> Default for BitIdxError<R> where
    R: BitRegister, 

fn default() -> BitIdxError<R>

Returns the “default value” for a type.

impl<R> Display for BitIdxError<R> where
    R: BitRegister, 

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

Formats the value using the given formatter.

impl<R: Eq> Eq for BitIdxError<R> where
    R: BitRegister, 

impl<R> Error for BitIdxError<R> where
    R: BitRegister, 

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

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl<T> From<BitIdxError<<T as BitStore>::Mem>> for BitPtrError<T> where
    T: BitStore, 

fn from(err: BitIdxError<T::Mem>) -> Self

Performs the conversion.

impl<R: Hash> Hash for BitIdxError<R> where
    R: BitRegister, 

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<R: Ord> Ord for BitIdxError<R> where
    R: BitRegister, 

fn cmp(&self, other: &BitIdxError<R>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<R: PartialEq> PartialEq<BitIdxError<R>> for BitIdxError<R> where
    R: BitRegister, 

fn eq(&self, other: &BitIdxError<R>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BitIdxError<R>) -> bool

This method tests for !=.

impl<R: PartialOrd> PartialOrd<BitIdxError<R>> for BitIdxError<R> where
    R: BitRegister, 

fn partial_cmp(&self, other: &BitIdxError<R>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<R> StructuralEq for BitIdxError<R> where
    R: BitRegister, 

impl<R> StructuralPartialEq for BitIdxError<R> where
    R: BitRegister,