Enum rust_hdl::core::bits::Bits

pub enum Bits<const N: usize> {
    Short(ShortBitVec<N>),
    Long(BitVec<N>),
}

Variants

Short(ShortBitVec<N>)

Long(BitVec<N>)

Implementations

impl<const N: usize> Bits<N>

pub fn any(&self) -> bool

pub fn all(&self) -> bool

pub fn xor(&self) -> bool

pub fn index(&self) -> usize

pub fn len(&self) -> usize

pub fn count() -> usize

pub fn get_bit(&self, index: usize) -> bool

pub fn replace_bit(&self, index: usize, val: bool) -> Self

pub fn get_bits<const M: usize>(&self, index: usize) -> Bits<M>

pub fn set_bits<const M: usize>(&mut self, index: usize, rhs: Bits<M>)

pub fn mask() -> Bits<N>

pub const fn width() -> usize

Trait Implementations

impl<const N: usize> Add<Bits<N>> for Bits<N>

type Output = Bits<N>

The resulting type after applying the + operator.

fn add(self, rhs: Bits<N>) -> Self::Output

Performs the + operation.

impl<const N: usize> Add<Bits<N>> for usize

type Output = Bits<N>

The resulting type after applying the + operator.

fn add(self, rhs: Bits<N>) -> Self::Output

Performs the + operation.

impl<const N: usize> Add<bool> for Bits<N>

type Output = Bits<N>

The resulting type after applying the + operator.

fn add(self, rhs: bool) -> Self::Output

Performs the + operation.

impl<const N: usize> Add<u32> for Bits<N>

type Output = Bits<N>

The resulting type after applying the + operator.

fn add(self, rhs: u32) -> Self::Output

Performs the + operation.

impl<const N: usize> Add<u64> for Bits<N>

type Output = Bits<N>

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> Self::Output

Performs the + operation.

impl<const N: usize> Add<usize> for Bits<N>

type Output = Bits<N>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<const N: usize> Binary for Bits<N>

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

Formats the value using the given formatter.

impl<const N: usize> BitAnd<Bits<N>> for Bits<N>

type Output = Bits<N>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<const N: usize> BitAnd<Bits<N>> for usize

type Output = Bits<N>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<const N: usize> BitAnd<u32> for Bits<N>

type Output = Bits<N>

The resulting type after applying the & operator.

fn bitand(self, rhs: u32) -> Self::Output

Performs the & operation.

impl<const N: usize> BitAnd<u64> for Bits<N>

type Output = Bits<N>

The resulting type after applying the & operator.

fn bitand(self, rhs: u64) -> Self::Output

Performs the & operation.

impl<const N: usize> BitAnd<usize> for Bits<N>

type Output = Bits<N>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<const N: usize> BitOr<Bits<N>> for Bits<N>

type Output = Bits<N>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<const N: usize> BitOr<Bits<N>> for usize

type Output = Bits<N>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<const N: usize> BitOr<u32> for Bits<N>

type Output = Bits<N>

The resulting type after applying the | operator.

fn bitor(self, rhs: u32) -> Self::Output

Performs the | operation.

impl<const N: usize> BitOr<u64> for Bits<N>

type Output = Bits<N>

The resulting type after applying the | operator.

fn bitor(self, rhs: u64) -> Self::Output

Performs the | operation.

impl<const N: usize> BitOr<usize> for Bits<N>

type Output = Bits<N>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<const N: usize> BitXor<Bits<N>> for Bits<N>

type Output = Bits<N>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<const N: usize> BitXor<Bits<N>> for usize

type Output = Bits<N>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<const N: usize> BitXor<u32> for Bits<N>

type Output = Bits<N>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: u32) -> Self::Output

Performs the ^ operation.

impl<const N: usize> BitXor<u64> for Bits<N>

type Output = Bits<N>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: u64) -> Self::Output

Performs the ^ operation.

impl<const N: usize> BitXor<usize> for Bits<N>

type Output = Bits<N>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<const N: usize> Clone for Bits<N>

fn clone(&self) -> Bits<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for Bits<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for Bits<N>

fn default() -> Bits<N>

Returns the “default value” for a type.

impl<const N: usize> From<BigUint> for Bits<N>

fn from(x: BigUint) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Bits<N>> for u8

fn from(x: Bits<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Bits<N>> for u16

fn from(x: Bits<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Bits<N>> for u32

fn from(x: Bits<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Bits<N>> for u64

fn from(x: Bits<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Bits<N>> for u128

fn from(x: Bits<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Bits<N>> for usize

fn from(x: Bits<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Wrapping<u128>> for Bits<N>

fn from(x: Wrapping<u128>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Wrapping<u16>> for Bits<N>

fn from(x: Wrapping<u16>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Wrapping<u32>> for Bits<N>

fn from(x: Wrapping<u32>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Wrapping<u64>> for Bits<N>

fn from(x: Wrapping<u64>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Wrapping<u8>> for Bits<N>

fn from(x: Wrapping<u8>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Wrapping<usize>> for Bits<N>

fn from(x: Wrapping<usize>) -> Self

Converts to this type from the input type.

impl From<bool> for Bits<1>

fn from(x: bool) -> Self

Converts to this type from the input type.

impl<const N: usize> From<u128> for Bits<N>

fn from(x: u128) -> Self

Converts to this type from the input type.

impl<const N: usize> From<u16> for Bits<N>

fn from(x: u16) -> Self

Converts to this type from the input type.

impl<const N: usize> From<u32> for Bits<N>

fn from(x: u32) -> Self

Converts to this type from the input type.

impl<const N: usize> From<u64> for Bits<N>

fn from(x: u64) -> Self

Converts to this type from the input type.

impl<const N: usize> From<u8> for Bits<N>

fn from(x: u8) -> Self

Converts to this type from the input type.

impl<const N: usize> From<usize> for Bits<N>

fn from(x: usize) -> Self

Converts to this type from the input type.

impl<const N: usize> Hash for Bits<N>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Into<Bits<LogicState>> for BankState

fn into(self) -> Bits<{ BankState::BITS }>

Converts this type into the (usually inferred) input type.

impl Into<Bits<LogicState>> for I2CControllerCmd

fn into(self) -> Bits<{ I2CControllerCmd::BITS }>

Converts this type into the (usually inferred) input type.

impl Into<Bits<LogicState>> for I2CDriverCmd

fn into(self) -> Bits<{ I2CDriverCmd::BITS }>

Converts this type into the (usually inferred) input type.

impl Into<Bits<LogicState>> for SDRAMCommand

fn into(self) -> Bits<{ SDRAMCommand::BITS }>

Converts this type into the (usually inferred) input type.

impl<const N: usize> Into<VCDValue> for Bits<N>

fn into(self) -> VCDValue

Converts this type into the (usually inferred) input type.

impl Into<bool> for Bits<1>

fn into(self) -> bool

Converts this type into the (usually inferred) input type.

impl<const N: usize> LowerHex for Bits<N>

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

Formats the value using the given formatter.

impl Mul<Bits<16_usize>> for Bits<16>

Multipliers are special, so we only implement multipliers that we think are synthesizable. In this case, we implement a 16 x 16 bit multiplier which yields a 32 bit result.

type Output = Bits<32_usize>

The resulting type after applying the * operator.

fn mul(self, rhs: Bits<16>) -> Self::Output

Performs the * operation.

impl<const N: usize> Not for Bits<N>

type Output = Bits<N>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<const N: usize> Ord for Bits<N>

fn cmp(&self, other: &Bits<N>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<const N: usize> PartialEq<Bits<N>> for Bits<N>

fn eq(&self, other: &Bits<N>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<bool> for Bits<1>

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<const N: usize> PartialEq<u128> for Bits<N>

fn eq(&self, other: &u128) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<const N: usize> PartialEq<u16> for Bits<N>

fn eq(&self, other: &u16) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<const N: usize> PartialEq<u32> for Bits<N>

fn eq(&self, other: &u32) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<const N: usize> PartialEq<u64> for Bits<N>

fn eq(&self, other: &u64) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<const N: usize> PartialEq<u8> for Bits<N>

fn eq(&self, other: &u8) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<const N: usize> PartialEq<usize> for Bits<N>

fn eq(&self, other: &usize) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<const N: usize> PartialOrd<Bits<N>> for Bits<N>

fn partial_cmp(&self, other: &Bits<N>) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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<const N: usize> Shl<Bits<N>> for Bits<N>

type Output = Bits<N>

The resulting type after applying the << operator.

fn shl(self, rhs: Bits<N>) -> Self::Output

Performs the << operation.

impl<const N: usize> Shl<Bits<N>> for usize

type Output = Bits<N>

The resulting type after applying the << operator.

fn shl(self, rhs: Bits<N>) -> Self::Output

Performs the << operation.

impl<const N: usize> Shl<u32> for Bits<N>

type Output = Bits<N>

The resulting type after applying the << operator.

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

Performs the << operation.

impl<const N: usize> Shl<u64> for Bits<N>

type Output = Bits<N>

The resulting type after applying the << operator.

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

Performs the << operation.

impl<const N: usize> Shl<usize> for Bits<N>

type Output = Bits<N>

The resulting type after applying the << operator.

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

Performs the << operation.

impl<const N: usize> Shr<Bits<N>> for Bits<N>

type Output = Bits<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: Bits<N>) -> Self::Output

Performs the >> operation.

impl<const N: usize> Shr<Bits<N>> for usize

type Output = Bits<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: Bits<N>) -> Self::Output

Performs the >> operation.

impl<const N: usize> Shr<u32> for Bits<N>

type Output = Bits<N>

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<const N: usize> Shr<u64> for Bits<N>

type Output = Bits<N>

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<const N: usize> Shr<usize> for Bits<N>

type Output = Bits<N>

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<const N: usize> Sub<Bits<N>> for Bits<N>

type Output = Bits<N>

The resulting type after applying the - operator.

fn sub(self, rhs: Bits<N>) -> Self::Output

Performs the - operation.

impl<const N: usize> Sub<Bits<N>> for usize

type Output = Bits<N>

The resulting type after applying the - operator.

fn sub(self, rhs: Bits<N>) -> Self::Output

Performs the - operation.

impl<const N: usize> Sub<u32> for Bits<N>

type Output = Bits<N>

The resulting type after applying the - operator.

fn sub(self, rhs: u32) -> Self::Output

Performs the - operation.

impl<const N: usize> Sub<u64> for Bits<N>

type Output = Bits<N>

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> Self::Output

Performs the - operation.

impl<const N: usize> Sub<usize> for Bits<N>

type Output = Bits<N>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const N: usize> Synth for Bits<N>

const BITS: usize = N

fn descriptor() -> TypeDescriptor

fn vcd(self) -> VCDValue

fn verilog(self) -> VerilogLiteral

impl<const N: usize> UpperHex for Bits<N>

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

Formats the value using the given formatter.

impl<const N: usize> Copy for Bits<N>

impl<const N: usize> Eq for Bits<N>