Struct B5

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

a type used to represent a field with a specific amount of bits.

Implementations

impl B5

pub const MAX: Self

the max allowed value for this type.

pub const BIT_LENGTH: usize = 5usize

the bit length of this type.

pub fn new(value: <BitLength<5> as AssociatedStorage>::Storage) -> Option<Self>

creates a new instance of this bitfield type with the given value.

if the value does not fit within the bit length of this type, returns None.

pub unsafe fn new_unchecked( value: <BitLength<5> as AssociatedStorage>::Storage, ) -> Self

creates a new instance of this bitfield type with the given value, without checking that the value fits within the bit length of this type.

safety

the provided value must fit withing the bit length of this type.

pub fn get(&self) -> <BitLength<5> as AssociatedStorage>::Storage

returns the inner value.

Trait Implementations

impl BitPiece for B5

const BITS: usize = 5usize

the length in bits of this type.

type Bits = <BitLength<5> as AssociatedStorage>::Storage

the storage type used internally to store the bits of this bitpiece.

type Fields = B5

the type which represents the expanded view of this bitpiece.

type Mut<'s, S: BitStorage + 's> = GenericBitPieceMut<'s, S, B5>

the type used to represent a mutable reference to this type inside another bitpiece.

fn from_fields(fields: Self::Fields) -> Self

constructs this type from the given fields.

fn to_fields(self) -> Self::Fields

return the values of all fields of this bitpiece.

fn from_bits(bits: Self::Bits) -> Self

constructs this type from the given bits.

fn to_bits(self) -> Self::Bits

returns the underlying bits of this type.

fn zeroes() -> Self

constructs this type with a value of zero for all fields.

fn ones() -> Self

constructs this type with a value of one for all fields.

impl Clone for B5

fn clone(&self) -> B5

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for B5

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

Formats the value using the given formatter.

impl Default for B5

fn default() -> B5

Returns the “default value” for a type.

impl Display for B5

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

Formats the value using the given formatter.

impl Hash for B5

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 B5

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

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

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

impl Eq for B5

impl StructuralPartialEq for B5