Struct Bits

pub struct Bits<const BITS: usize, const LIMBS: usize>(/* private fields */);

A newtype wrapper around Uint that restricts operations to those relevant for bit arrays.

Implementations

impl<const BITS: usize, const LIMBS: usize> Bits<BITS, LIMBS>

pub const LIMBS: usize = Uint<BITS, LIMBS>::LIMBS

The size of this integer type in 64-bit limbs.

pub const BITS: usize = Uint<BITS, LIMBS>::BITS

The size of this integer type in bits.

pub const BYTES: usize = Uint<BITS, LIMBS>::BYTES

The size of this integer type in bits.

pub const ZERO: Bits<BITS, LIMBS>

The value zero. This is the only value that exists in all Uint types.

pub const fn into_inner(self) -> Uint<BITS, LIMBS>

Returns the inner Uint.

pub const fn as_uint(&self) -> &Uint<BITS, LIMBS>

Returns a reference to the inner Uint.

pub fn as_uint_mut(&mut self) -> &mut Uint<BITS, LIMBS>

Returns a mutable reference to the inner Uint.

impl<const BITS: usize, const LIMBS: usize> Bits<BITS, LIMBS>

pub fn reverse_bits(self) -> Bits<BITS, LIMBS>

See Uint::reverse_bits for documentation.

pub fn as_le_bytes(&self) -> Cow<'_, [u8]>

See Uint::as_le_bytes for documentation.

pub fn to_be_bytes_vec(&self) -> Vec<u8>

See Uint::to_be_bytes_vec for documentation.

pub fn to_le_bytes<const BYTES: usize>(&self) -> [u8; BYTES]

See Uint::to_le_bytes for documentation.

pub fn to_be_bytes<const BYTES: usize>(&self) -> [u8; BYTES]

See Uint::to_be_bytes for documentation.

pub fn leading_zeros(&self) -> usize

See Uint::leading_zeros for documentation.

pub fn leading_ones(&self) -> usize

See Uint::leading_ones for documentation.

pub fn trailing_zeros(&self) -> usize

See Uint::trailing_zeros for documentation.

pub fn trailing_ones(&self) -> usize

See Uint::trailing_ones for documentation.

pub unsafe fn as_limbs_mut(&mut self) -> &mut [u64; LIMBS]

See Uint::as_limbs_mut for documentation.

pub fn checked_shl(self, rhs: usize) -> Option<Bits<BITS, LIMBS>>

See Uint::checked_shl for documentation.

pub fn checked_shr(self, rhs: usize) -> Option<Bits<BITS, LIMBS>>

See Uint::checked_shr for documentation.

pub fn overflowing_shl(self, rhs: usize) -> (Bits<BITS, LIMBS>, bool)

See Uint::overflowing_shl for documentation.

pub fn overflowing_shr(self, rhs: usize) -> (Bits<BITS, LIMBS>, bool)

See Uint::overflowing_shr for documentation.

pub fn wrapping_shl(self, rhs: usize) -> Bits<BITS, LIMBS>

See Uint::wrapping_shl for documentation.

pub fn wrapping_shr(self, rhs: usize) -> Bits<BITS, LIMBS>

See Uint::wrapping_shr for documentation.

pub fn rotate_left(self, rhs: usize) -> Bits<BITS, LIMBS>

See Uint::rotate_left for documentation.

pub fn rotate_right(self, rhs: usize) -> Bits<BITS, LIMBS>

See Uint::rotate_right for documentation.

pub fn try_from_be_slice(bytes: &[u8]) -> Option<Bits<BITS, LIMBS>>

See Uint::try_from_be_slice for documentation.

pub fn try_from_le_slice(bytes: &[u8]) -> Option<Bits<BITS, LIMBS>>

See Uint::try_from_le_slice for documentation.

pub fn from_str_radix( src: &str, radix: u64, ) -> Result<Bits<BITS, LIMBS>, ParseError>

See Uint::from_str_radix for documentation.

pub fn from_be_bytes<const BYTES: usize>( bytes: [u8; BYTES], ) -> Bits<BITS, LIMBS>

See Uint::from_be_bytes for documentation.

pub fn from_le_bytes<const BYTES: usize>( bytes: [u8; BYTES], ) -> Bits<BITS, LIMBS>

See Uint::from_le_bytes for documentation.

pub const fn from_limbs(limbs: [u64; LIMBS]) -> Bits<BITS, LIMBS>

See Uint::from_limbs for documentation.

pub const fn as_limbs(&self) -> &[u64; LIMBS]

See Uint::as_limbs for documentation.

Trait Implementations

impl<const BITS: usize, const LIMBS: usize> BitAnd<&Bits<BITS, LIMBS>> for &Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the & operator.

fn bitand( self, rhs: &Bits<BITS, LIMBS>, ) -> <&Bits<BITS, LIMBS> as BitAnd<&Bits<BITS, LIMBS>>>::Output

Performs the & operation.

impl<const BITS: usize, const LIMBS: usize> BitAnd<&Bits<BITS, LIMBS>> for Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the & operator.

fn bitand( self, rhs: &Bits<BITS, LIMBS>, ) -> <Bits<BITS, LIMBS> as BitAnd<&Bits<BITS, LIMBS>>>::Output

Performs the & operation.

impl<const BITS: usize, const LIMBS: usize> BitAnd<Bits<BITS, LIMBS>> for &Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the & operator.

fn bitand( self, rhs: Bits<BITS, LIMBS>, ) -> <&Bits<BITS, LIMBS> as BitAnd<Bits<BITS, LIMBS>>>::Output

Performs the & operation.

impl<const BITS: usize, const LIMBS: usize> BitAnd for Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the & operator.

fn bitand(self, rhs: Bits<BITS, LIMBS>) -> <Bits<BITS, LIMBS> as BitAnd>::Output

Performs the & operation.

impl<const BITS: usize, const LIMBS: usize> BitAndAssign<&Bits<BITS, LIMBS>> for Bits<BITS, LIMBS>

fn bitand_assign(&mut self, rhs: &Bits<BITS, LIMBS>)

Performs the &= operation.

impl<const BITS: usize, const LIMBS: usize> BitAndAssign for Bits<BITS, LIMBS>

fn bitand_assign(&mut self, rhs: Bits<BITS, LIMBS>)

Performs the &= operation.

impl<const BITS: usize, const LIMBS: usize> BitOr<&Bits<BITS, LIMBS>> for &Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the | operator.

fn bitor( self, rhs: &Bits<BITS, LIMBS>, ) -> <&Bits<BITS, LIMBS> as BitOr<&Bits<BITS, LIMBS>>>::Output

Performs the | operation.

impl<const BITS: usize, const LIMBS: usize> BitOr<&Bits<BITS, LIMBS>> for Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the | operator.

fn bitor( self, rhs: &Bits<BITS, LIMBS>, ) -> <Bits<BITS, LIMBS> as BitOr<&Bits<BITS, LIMBS>>>::Output

Performs the | operation.

impl<const BITS: usize, const LIMBS: usize> BitOr<Bits<BITS, LIMBS>> for &Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the | operator.

fn bitor( self, rhs: Bits<BITS, LIMBS>, ) -> <&Bits<BITS, LIMBS> as BitOr<Bits<BITS, LIMBS>>>::Output

Performs the | operation.

impl<const BITS: usize, const LIMBS: usize> BitOr for Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the | operator.

fn bitor(self, rhs: Bits<BITS, LIMBS>) -> <Bits<BITS, LIMBS> as BitOr>::Output

Performs the | operation.

impl<const BITS: usize, const LIMBS: usize> BitOrAssign<&Bits<BITS, LIMBS>> for Bits<BITS, LIMBS>

fn bitor_assign(&mut self, rhs: &Bits<BITS, LIMBS>)

Performs the |= operation.

impl<const BITS: usize, const LIMBS: usize> BitOrAssign for Bits<BITS, LIMBS>

fn bitor_assign(&mut self, rhs: Bits<BITS, LIMBS>)

Performs the |= operation.

impl<const BITS: usize, const LIMBS: usize> BitXor<&Bits<BITS, LIMBS>> for &Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the ^ operator.

fn bitxor( self, rhs: &Bits<BITS, LIMBS>, ) -> <&Bits<BITS, LIMBS> as BitXor<&Bits<BITS, LIMBS>>>::Output

Performs the ^ operation.

impl<const BITS: usize, const LIMBS: usize> BitXor<&Bits<BITS, LIMBS>> for Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the ^ operator.

fn bitxor( self, rhs: &Bits<BITS, LIMBS>, ) -> <Bits<BITS, LIMBS> as BitXor<&Bits<BITS, LIMBS>>>::Output

Performs the ^ operation.

impl<const BITS: usize, const LIMBS: usize> BitXor<Bits<BITS, LIMBS>> for &Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the ^ operator.

fn bitxor( self, rhs: Bits<BITS, LIMBS>, ) -> <&Bits<BITS, LIMBS> as BitXor<Bits<BITS, LIMBS>>>::Output

Performs the ^ operation.

impl<const BITS: usize, const LIMBS: usize> BitXor for Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Bits<BITS, LIMBS>) -> <Bits<BITS, LIMBS> as BitXor>::Output

Performs the ^ operation.

impl<const BITS: usize, const LIMBS: usize> BitXorAssign<&Bits<BITS, LIMBS>> for Bits<BITS, LIMBS>

fn bitxor_assign(&mut self, rhs: &Bits<BITS, LIMBS>)

Performs the ^= operation.

impl<const BITS: usize, const LIMBS: usize> BitXorAssign for Bits<BITS, LIMBS>

fn bitxor_assign(&mut self, rhs: Bits<BITS, LIMBS>)

Performs the ^= operation.

impl<const BITS: usize, const LIMBS: usize> Clone for Bits<BITS, LIMBS>

fn clone(&self) -> Bits<BITS, LIMBS>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const BITS: usize, const LIMBS: usize> Debug for Bits<BITS, LIMBS>

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

Formats the value using the given formatter.

impl<const BITS: usize, const LIMBS: usize> Default for Bits<BITS, LIMBS>

fn default() -> Bits<BITS, LIMBS>

Returns the “default value” for a type.

impl<'de, const BITS: usize, const LIMBS: usize> Deserialize<'de> for Bits<BITS, LIMBS>

fn deserialize<D>( deserializer: D, ) -> Result<Bits<BITS, LIMBS>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const BITS: usize, const LIMBS: usize> From<Bits<BITS, LIMBS>> for Uint<BITS, LIMBS>

fn from(value: Bits<BITS, LIMBS>) -> Uint<BITS, LIMBS>

Converts to this type from the input type.

impl<const BITS: usize, const LIMBS: usize> From<Uint<BITS, LIMBS>> for Bits<BITS, LIMBS>

fn from(value: Uint<BITS, LIMBS>) -> Bits<BITS, LIMBS>

Converts to this type from the input type.

impl<const BITS: usize, const LIMBS: usize> FromStr for Bits<BITS, LIMBS>

type Err = <Uint<BITS, LIMBS> as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str( src: &str, ) -> Result<Bits<BITS, LIMBS>, <Bits<BITS, LIMBS> as FromStr>::Err>

Parses a string s to return a value of this type.

impl<const BITS: usize, const LIMBS: usize> Hash for Bits<BITS, LIMBS>

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<const BITS: usize, const LIMBS: usize> Index<usize> for Bits<BITS, LIMBS>

type Output = bool

The returned type after indexing.

fn index(&self, index: usize) -> &<Bits<BITS, LIMBS> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl<const BITS: usize, const LIMBS: usize> Not for &Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the ! operator.

fn not(self) -> Bits<BITS, LIMBS>

Performs the unary ! operation.

impl<const BITS: usize, const LIMBS: usize> Not for Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the ! operator.

fn not(self) -> Bits<BITS, LIMBS>

Performs the unary ! operation.

impl<const BITS: usize, const LIMBS: usize> PartialEq for Bits<BITS, LIMBS>

fn eq(&self, other: &Bits<BITS, LIMBS>) -> 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<const BITS: usize, const LIMBS: usize> Serialize for Bits<BITS, LIMBS>

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.

impl<const BITS: usize, const LIMBS: usize> Shl<&usize> for &Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the << operator.

fn shl(self, rhs: &usize) -> <&Bits<BITS, LIMBS> as Shl<&usize>>::Output

Performs the << operation.

impl<const BITS: usize, const LIMBS: usize> Shl<&usize> for Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the << operator.

fn shl(self, rhs: &usize) -> Bits<BITS, LIMBS>

Performs the << operation.

impl<const BITS: usize, const LIMBS: usize> Shl<usize> for &Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> <&Bits<BITS, LIMBS> as Shl<usize>>::Output

Performs the << operation.

impl<const BITS: usize, const LIMBS: usize> Shl<usize> for Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> Bits<BITS, LIMBS>

Performs the << operation.

impl<const BITS: usize, const LIMBS: usize> ShlAssign<&usize> for Bits<BITS, LIMBS>

fn shl_assign(&mut self, rhs: &usize)

Performs the <<= operation.

impl<const BITS: usize, const LIMBS: usize> ShlAssign<usize> for Bits<BITS, LIMBS>

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl<const BITS: usize, const LIMBS: usize> Shr<&usize> for &Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the >> operator.

fn shr(self, rhs: &usize) -> <&Bits<BITS, LIMBS> as Shr<&usize>>::Output

Performs the >> operation.

impl<const BITS: usize, const LIMBS: usize> Shr<&usize> for Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the >> operator.

fn shr(self, rhs: &usize) -> Bits<BITS, LIMBS>

Performs the >> operation.

impl<const BITS: usize, const LIMBS: usize> Shr<usize> for &Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> <&Bits<BITS, LIMBS> as Shr<usize>>::Output

Performs the >> operation.

impl<const BITS: usize, const LIMBS: usize> Shr<usize> for Bits<BITS, LIMBS>

type Output = Bits<BITS, LIMBS>

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Bits<BITS, LIMBS>

Performs the >> operation.

impl<const BITS: usize, const LIMBS: usize> ShrAssign<&usize> for Bits<BITS, LIMBS>

fn shr_assign(&mut self, rhs: &usize)

Performs the >>= operation.

impl<const BITS: usize, const LIMBS: usize> ShrAssign<usize> for Bits<BITS, LIMBS>

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl<const BITS: usize, const LIMBS: usize> Copy for Bits<BITS, LIMBS>

impl<const BITS: usize, const LIMBS: usize> Eq for Bits<BITS, LIMBS>

impl<const BITS: usize, const LIMBS: usize> StructuralPartialEq for Bits<BITS, LIMBS>