Struct Bits 

pub struct Bits { /* private fields */ }

Which bits of a value are known, and what they are.

A set bit in unknown means that bit could be either. A clear one means value has it. The two are kept canonical, so a bit that is unknown is zero in value, which makes equality mean what it looks like.

Implementations

impl Bits

pub const fn unknown(width: u32) -> Self

Nothing known at this width.

pub const fn exactly(value: u128, width: u32) -> Self

Every bit known, and these are they.

pub const fn known(self, width: u32) -> u128

The bits that are known, as a mask.

pub const fn value(self) -> u128

What the known bits are, with the unknown ones zero.

pub const fn min(self) -> u128

The smallest value these bits allow, which is the unknown ones all zero.

pub const fn max(self) -> u128

The largest, which is the unknown ones all one.

pub const fn allows(self, value: u128) -> bool

Whether this value is one these bits allow.

pub const fn from_parts(value: u128, unknown: u128, width: u32) -> Self

Bits from a value and a mask of which of them mean nothing.

This is the way in for an operation that worked out its answer a bit at a time, which is every bitwise operation. The value is canonicalized, so a bit that is unknown comes back zero however it went in.

pub const fn unknown_bits(self) -> u128

The bits that mean nothing, as a mask.

pub const fn low_zeros(self) -> u32

How many low bits are known to be zero, which is what says a value is a multiple of a power of two and so what an alignment fact is made of.

pub fn meet(self, other: Self) -> Option<Self>

Everything both of these know, or None when they contradict each other.

A contradiction is not a failure. It is the proof that whatever produced the two facts is on a path that is never taken, and the caller turns it into the empty range.

pub fn join(self, other: Self) -> Self

Only what both of these agree on, which is what a value from either place is known to be.

Trait Implementations

impl Clone for Bits

fn clone(&self) -> Bits

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Bits

impl Debug for Bits

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

Formats the value using the given formatter.

impl Eq for Bits

impl PartialEq for Bits

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Bits