Struct ruint::Bits

source · [−]

pub struct Bits<const BITS: usize, const LIMBS: usize>(_);

Expand description

Bit vector

This is a newtype wrapper around Uint<BITS, LIMBS> that restricts operations to those relevant for bit vectors.

Implementations

source

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

source

pub const LIMBS: usize = Uint::::LIMBS

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

source

pub const BITS: usize = Uint::::BITS

The size of this integer type in bits.

source

pub const BYTES: usize = Uint::::BYTES

The size of this integer type in bits.

source

pub const ZERO: Self = Self(Uint::::ZERO)

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

source

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

source

pub fn reverse_bits(self) -> Self

See Uint::reverse_bits for documentation.

source

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

See Uint::as_le_bytes for documentation.

source

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

See Uint::as_limbs for documentation.

source

pub fn leading_zeros(&self) -> usize

See Uint::leading_zeros for documentation.

source

pub fn leading_ones(&self) -> usize

See Uint::leading_ones for documentation.

source

pub fn trailing_zeros(&self) -> usize

See Uint::trailing_zeros for documentation.

source

pub fn trailing_ones(&self) -> usize

See Uint::trailing_ones for documentation.

source

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

See Uint::as_limbs_mut for documentation.

source

pub fn checked_shl(self, a: usize) -> Option<Self>

See Uint::checked_shl for documentation.

source

pub fn checked_shr(self, a: usize) -> Option<Self>

See Uint::checked_shr for documentation.

source

pub fn overflowing_shl(self, a: usize) -> (Self, bool )

See Uint::overflowing_shl for documentation.

source

pub fn overflowing_shr(self, a: usize) -> (Self, bool )

See Uint::overflowing_shr for documentation.

source

pub fn wrapping_shl(self, a: usize) -> Self

See Uint::wrapping_shl for documentation.

source

pub fn wrapping_shr(self, a: usize) -> Self

See Uint::wrapping_shr for documentation.

source

pub fn rotate_left(self, a: usize) -> Self

See Uint::rotate_left for documentation.

source

pub fn rotate_right(self, a: usize) -> Self

See Uint::rotate_right for documentation.

Trait Implementations

source

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.

source

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

Performs the & operation. Read more

source

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.

source

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

Performs the & operation. Read more

source

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.

source

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

Performs the & operation. Read more

source

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.

source

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

Performs the & operation. Read more

source

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

source

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

Performs the &= operation. Read more

source

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

source

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

Performs the &= operation. Read more

source

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.

source

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

Performs the | operation. Read more

source

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.

source

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

Performs the | operation. Read more

source

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.

source

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

Performs the | operation. Read more

source

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.

source

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

Performs the | operation. Read more

source

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

source

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

Performs the |= operation. Read more

source

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

source

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

Performs the |= operation. Read more

source

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.

source

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

Performs the ^ operation. Read more

source

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.

source

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

Performs the ^ operation. Read more

source

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.

source

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

Performs the ^ operation. Read more

source

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.

source

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

Performs the ^ operation. Read more

source

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

source

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

Performs the ^= operation. Read more

source

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

source

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

Performs the ^= operation. Read more

source

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

source

fn from(x: Bits<BITS, LIMBS>) -> Self

Converts to this type from the input type.

source

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

source

fn from(x: Uint<BITS, LIMBS>) -> Self

Converts to this type from the input type.

source

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

type Output = bool

The returned type after indexing.

source

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation. Read more

source

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

type Output = Bits<BITS, LIMBS>

The resulting type after applying the ! operator.

source

fn not(self) -> Self

Performs the unary ! operation. Read more

source

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

type Output = Bits<BITS, LIMBS>

The resulting type after applying the ! operator.

source

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

Performs the unary ! operation. Read more

source

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.

source

fn shl(self, rhs: &usize) -> Self

Performs the << operation. Read more

source

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.

source

fn shl(self, rhs: &usize) -> Self::Output

Performs the << operation. Read more

source

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.

source

fn shl(self, rhs: usize) -> Self

Performs the << operation. Read more

source

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.

source

fn shl(self, rhs: usize) -> Self::Output

Performs the << operation. Read more

source

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

source

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

Performs the <<= operation. Read more

source

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

source

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation. Read more

source

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.

source

fn shr(self, rhs: &usize) -> Self

Performs the >> operation. Read more

source

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.

source

fn shr(self, rhs: &usize) -> Self::Output

Performs the >> operation. Read more

source

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.

source

fn shr(self, rhs: usize) -> Self

Performs the >> operation. Read more

source

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.

source

fn shr(self, rhs: usize) -> Self::Output

Performs the >> operation. Read more

source

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

source

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

Performs the >>= operation. Read more

source

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

source

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation. Read more

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct ruint::Bits

Implementations

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

pub const LIMBS: usize = Uint::::LIMBS

pub const BITS: usize = Uint::::BITS

pub const BYTES: usize = Uint::::BYTES

pub const ZERO: Self = Self(Uint::::ZERO)

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

pub fn reverse_bits(self) -> Self

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

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

pub fn leading_zeros(&self) -> usize

pub fn leading_ones(&self) -> usize

pub fn trailing_zeros(&self) -> usize

pub fn trailing_ones(&self) -> usize

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

pub fn checked_shl(self, a: usize) -> Option<Self>

pub fn checked_shr(self, a: usize) -> Option<Self>

pub fn overflowing_shl(self, a: usize) -> (Self, bool)

pub fn overflowing_shr(self, a: usize) -> (Self, bool)

pub fn wrapping_shl(self, a: usize) -> Self

pub fn wrapping_shr(self, a: usize) -> Self

pub fn rotate_left(self, a: usize) -> Self

pub fn rotate_right(self, a: usize) -> Self

Trait Implementations

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

type Output = Bits<BITS, LIMBS>

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

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

type Output = Bits<BITS, LIMBS>

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

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

type Output = Bits<BITS, LIMBS>

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

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

type Output = Bits<BITS, LIMBS>

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

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

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

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

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

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

type Output = Bits<BITS, LIMBS>

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

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

type Output = Bits<BITS, LIMBS>

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

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

type Output = Bits<BITS, LIMBS>

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

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

type Output = Bits<BITS, LIMBS>

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

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

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

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

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

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

type Output = Bits<BITS, LIMBS>

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

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

type Output = Bits<BITS, LIMBS>

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

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

type Output = Bits<BITS, LIMBS>

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

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

type Output = Bits<BITS, LIMBS>

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

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

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

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

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

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

fn from(x: Bits<BITS, LIMBS>) -> Self

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

fn from(x: Uint<BITS, LIMBS>) -> Self

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

type Output = bool

fn index(&self, index: usize) -> &Self::Output

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

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

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

pub fn overflowing_shl(self, a: usize) -> (Self, bool )

pub fn overflowing_shr(self, a: usize) -> (Self, bool )

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,