Struct SB5 

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

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

Implementations

impl SB5

pub const fn from_fields(fields: Self) -> Self

pub const fn to_fields(x: Self) -> Self

pub const fn try_from_bits( bits: <BitLength<5> as AssociatedStorage>::Storage, ) -> Option<Self>

pub const fn from_bits( bits: <BitLength<5> as AssociatedStorage>::Storage, ) -> Self

pub const fn to_bits(self) -> <BitLength<5> as AssociatedStorage>::Storage

pub const fn const_eq(a: Self, b: Self) -> bool

impl SB5

pub const fn new( value: <<BitLength<5> as AssociatedStorage>::Storage as BitStorage>::Signed, ) -> Self

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

this function panics if the value does not fit within the bit length of this type.

pub const fn try_new( value: <<BitLength<5> as AssociatedStorage>::Storage as BitStorage>::Signed, ) -> 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 const unsafe fn new_unchecked( value: <<BitLength<5> as AssociatedStorage>::Storage as BitStorage>::Signed, ) -> 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 within the bit length of this type.

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

returns the inner value.

Trait Implementations

impl BitPiece for SB5

const BITS: usize = 5

the length in bits of this type.

const ZEROES: Self

a value with all zero bits.

const ONES: Self

a value with all one bits.

const MIN: Self

the minimum value.

const MAX: Self

the maximum value.

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

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

type Converter = SB5

a converter types which implements all const conversion functions (e.g from_bits).

fn try_from_bits(bits: Self::Bits) -> Option<Self>

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

fn to_bits(self) -> Self::Bits

impl BitPieceHasFields for SB5

type Fields = SB5

the type which represents the expanded view of this bitpiece.

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

fn to_fields(self) -> Self::Fields

impl BitPieceHasMutRef for SB5

type MutRef<'s> = SB5MutRef<'s>

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

impl Clone for SB5

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SB5

impl Debug for SB5

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

Formats the value using the given formatter.

impl Default for SB5

fn default() -> Self

Returns the “default value” for a type.

impl Display for SB5

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

Formats the value using the given formatter.

impl Eq for SB5

impl From<i8> for SB5

fn from(x: i8) -> Self

Converts to this type from the input type.

impl From<i16> for SB5

fn from(x: i16) -> Self

Converts to this type from the input type.

impl From<i32> for SB5

fn from(x: i32) -> Self

Converts to this type from the input type.

impl From<i64> for SB5

fn from(x: i64) -> Self

Converts to this type from the input type.

impl From<u8> for SB5

fn from(x: u8) -> Self

Converts to this type from the input type.

impl From<u16> for SB5

fn from(x: u16) -> Self

Converts to this type from the input type.

impl From<u32> for SB5

fn from(x: u32) -> Self

Converts to this type from the input type.

impl From<u64> for SB5

fn from(x: u64) -> Self

Converts to this type from the input type.

impl Hash for SB5

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 SB5

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for SB5

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SB5

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for SB5