Struct BitWidth

pub struct BitWidth(/* private fields */);

The BitWidth represents the length of an ApInt.

Its invariant restricts it to always be a positive, non-zero value. Code that built’s on top of BitWidth may and should use this invariant.

Implementations

impl BitWidth

Constructors

pub fn w1() -> Self

Creates a BitWidth that represents a bit-width of 1 bit.

pub fn w8() -> Self

Creates a BitWidth that represents a bit-width of 8 bits.

pub fn w16() -> Self

Creates a BitWidth that represents a bit-width of 16 bits.

pub fn w32() -> Self

Creates a BitWidth that represents a bit-width of 32 bits.

pub fn w64() -> Self

Creates a BitWidth that represents a bit-width of 64 bits.

pub fn w128() -> Self

Creates a BitWidth that represents a bit-width of 128 bits.

pub fn new(width: usize) -> Result<Self>

Creates a BitWidth from the given usize.

Errors

• If the given width is equal to zero.

impl BitWidth

API

pub fn to_usize(self) -> usize

Converts this BitWidth into a usize.

Trait Implementations

impl Clone for BitWidth

fn clone(&self) -> BitWidth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitWidth

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BitWidth

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<usize> for BitWidth

fn from(width: usize) -> BitWidth

Converts to this type from the input type.

impl Hash for BitWidth

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BitWidth

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

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

fn partial_cmp(&self, other: &BitWidth) -> 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 Serialize for BitWidth

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for BitWidth

impl Eq for BitWidth

impl StructuralPartialEq for BitWidth