Trait bitint::UBitint

source ·

pub trait UBitint: Copy + Debug + Display + Hash + Eq + Ord + BitAnd<Output = Self> + BitAndAssign + BitOr<Output = Self> + BitOrAssign + BitXor<Output = Self> + BitXorAssign + TryFrom<Self::Primitive> + Into<Self::Primitive> + Num + NumAssignOps + Sized + Sealed {
    type Primitive: From<Self> + TryInto<Self>;

    const BITS: u32;
    const MASK: Self::Primitive;
    const MIN: Self;
    const MAX: Self;
    const ZERO: Self;
    const ONE: Self;

    // Required methods
    fn new(value: Self::Primitive) -> Option<Self>;
    fn new_masked(value: Self::Primitive) -> Self;
    unsafe fn new_unchecked(value: Self::Primitive) -> Self;
    fn is_in_range(value: Self::Primitive) -> bool;
}

Expand description

Unsigned bitint types.

There is one type implementing UBitint for each bit width from 1 to 128 inclusive.

Required Associated Types§

source

type Primitive: From<Self> + TryInto<Self>

The primitive type that this type wraps.

Required Associated Constants§

source

const BITS: u32

The bit width of this type.

source

const MASK: Self::Primitive

The bit mask for the bits that may be set in values of this type.

source

const MIN: Self

The smallest value of this type.

source

const MAX: Self

The largest value of this type.

source

const ZERO: Self

The value 0 represented in this type.

source

const ONE: Self

The value 1 represented in this type.

Required Methods§

source

fn new(value: Self::Primitive) -> Option<Self>

Creates an unsigned bitint value from a primitive value if it is in range for this type, as determined by is_in_range.

source

fn new_masked(value: Self::Primitive) -> Self

Creates an unsigned bitint value by masking off the upper bits of a primitive value.

This conversion is lossless if the value is in range for this type, as determined by is_in_range.

source

unsafe fn new_unchecked(value: Self::Primitive) -> Self

Creates an unsigned bitint value from a primitive value without checking whether it is in range for this type.

This is a zero-cost conversion.

Safety

The value must be in range for this type, as determined by is_in_range.

source

fn is_in_range(value: Self::Primitive) -> bool

Checks whether a primitive value is in range for this type.

There are a few equivalent ways to express this check.

The unused most significant bits are clear: (value & !Self::MASK) == 0
The value is between MIN and MAX, inclusive: value >= Self::MIN.as_primitive() && value <= Self::MAX.as_primitive()

Implementors§

source §

Trait bitint::UBitint

Required Associated Types§

type Primitive: From<Self> + TryInto<Self>

Required Associated Constants§

const BITS: u32

const MASK: Self::Primitive

const MIN: Self

const MAX: Self

const ZERO: Self

const ONE: Self

Required Methods§

fn new(value: Self::Primitive) -> Option<Self>

fn new_masked(value: Self::Primitive) -> Self

unsafe fn new_unchecked(value: Self::Primitive) -> Self

Safety

fn is_in_range(value: Self::Primitive) -> bool

Implementors§

impl UBitint for U1

type Primitive = u8

const BITS: u32 = 1u32

const MASK: u8 = 1u8

const MIN: Self = Self::MIN

const MAX: Self = Self::MAX

const ZERO: Self = Self::ZERO

const ONE: Self = Self::ONE

impl UBitint for U2

type Primitive = u8

const BITS: u32 = 2u32

const MASK: u8 = 3u8

const MIN: Self = Self::MIN

const MAX: Self = Self::MAX

const ZERO: Self = Self::ZERO

const ONE: Self = Self::ONE

impl UBitint for U3

type Primitive = u8

const BITS: u32 = 3u32

const MASK: u8 = 7u8

const MIN: Self = Self::MIN

const MAX: Self = Self::MAX

const ZERO: Self = Self::ZERO

const ONE: Self = Self::ONE

impl UBitint for U4

type Primitive = u8

const BITS: u32 = 4u32

const MASK: u8 = 15u8

const MIN: Self = Self::MIN

const MAX: Self = Self::MAX

const ZERO: Self = Self::ZERO

const ONE: Self = Self::ONE

impl UBitint for U5

type Primitive = u8

const BITS: u32 = 5u32

const MASK: u8 = 31u8

const MIN: Self = Self::MIN

const MAX: Self = Self::MAX

const ZERO: Self = Self::ZERO

const ONE: Self = Self::ONE

impl UBitint for U6

type Primitive = u8

const BITS: u32 = 6u32

const MASK: u8 = 63u8

const MIN: Self = Self::MIN

const MAX: Self = Self::MAX

const ZERO: Self = Self::ZERO

const ONE: Self = Self::ONE

impl UBitint for U7

type Primitive = u8

const BITS: u32 = 7u32

const MASK: u8 = 127u8

const MIN: Self = Self::MIN

const MAX: Self = Self::MAX

const ZERO: Self = Self::ZERO

const ONE: Self = Self::ONE

impl UBitint for U8

type Primitive = u8

const BITS: u32 = 8u32

const MASK: u8 = 255u8

const MIN: Self = Self::MIN

const MAX: Self = Self::MAX

const ZERO: Self = Self::ZERO