Trait BitMask

pub trait BitMask: BitSize {
    // Required methods
    fn mask(size: usize) -> Self;
    fn mask_to(&self, size: usize) -> Self;
}

Provides bit mask calculation and masking on values.

This trait defines type methods for generating a bit mask of a specified length and value methods for masking to a specified bit length.

Examples

use quark::BitMask;

let nibble_mask = u32::mask(4);
assert_eq!(nibble_mask, 0xf);

let value: u32 = 0x1234_5678;
assert_eq!(value.mask_to(12), 0x678);

Required Methods

fn mask(size: usize) -> Self

Returns a mask with the requested number of bits set.

fn mask_to(&self, size: usize) -> Self

Masks the value to the requested number of bits.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl BitMask for i8

fn mask(size: usize) -> Self

fn mask_to(&self, size: usize) -> Self

impl BitMask for i16

fn mask(size: usize) -> Self

fn mask_to(&self, size: usize) -> Self

impl BitMask for i32

fn mask(size: usize) -> Self

fn mask_to(&self, size: usize) -> Self

impl BitMask for i64

fn mask(size: usize) -> Self

fn mask_to(&self, size: usize) -> Self

impl BitMask for i128

fn mask(size: usize) -> Self

fn mask_to(&self, size: usize) -> Self

impl BitMask for isize

fn mask(size: usize) -> Self

fn mask_to(&self, size: usize) -> Self

impl BitMask for u8

fn mask(size: usize) -> Self

fn mask_to(&self, size: usize) -> Self

impl BitMask for u16

fn mask(size: usize) -> Self

fn mask_to(&self, size: usize) -> Self

impl BitMask for u32

fn mask(size: usize) -> Self

fn mask_to(&self, size: usize) -> Self

impl BitMask for u64

fn mask(size: usize) -> Self

fn mask_to(&self, size: usize) -> Self

impl BitMask for u128

fn mask(size: usize) -> Self

fn mask_to(&self, size: usize) -> Self

impl BitMask for usize

fn mask(size: usize) -> Self

fn mask_to(&self, size: usize) -> Self

Implementors