Struct halfling::Nibble

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

A byte-width nibble, representing a 4-bit unit of data.

While this type does not explicitly guarantee any particular memory layout, it does guarantee that the null pointer optimization applies: Option<Nibble> will always have the same size and alignment as Nibble.

Implementations

impl Nibble

pub const MIN: Self = _

0 as a Nibble.

pub const ZERO: Self = _

0 as a Nibble.

pub const ONE: Self = _

1 as a Nibble.

pub const TWO: Self = _

2 as a Nibble.

pub const THREE: Self = _

3 as a Nibble.

pub const FOUR: Self = _

4 as a Nibble.

pub const FIVE: Self = _

5 as a Nibble.

pub const SIX: Self = _

6 as a Nibble.

pub const SEVEN: Self = _

7 as a Nibble.

pub const EIGHT: Self = _

8 as a Nibble.

pub const NINE: Self = _

9 as a Nibble.

pub const TEN: Self = _

10 as a Nibble.

pub const ELEVEN: Self = _

11 as a Nibble.

pub const TWELVE: Self = _

12 as a Nibble.

pub const THIRTEEN: Self = _

13 as a Nibble.

pub const FOURTEEN: Self = _

14 as a Nibble.

pub const FIFTEEN: Self = _

15 as a Nibble.

pub const MAX: Self = _

15 as a Nibble.

impl Nibble

pub const BITS: u32 = 4u32

The minimum number of bits required to represent a nibble.

As opposed to the primitive integer types, this value is not the same as std::mem::sizeof<Nibble>() * 8; instead it reflects the smallest possible size that a nibble could be packed into.

pub const unsafe fn new_unchecked(value: u8) -> Self

Constructs a new Nibble representing the given value without checking invariants.

Safety

value must be strictly less than 16.

pub const fn new(value: u8) -> Option<Self>

Constructs a new Nibble representing the given value, or returns None if it is greater than 15.

pub const fn get(&self) -> u8

Consumes self and returns a u8 representing its value, guaranteed to be at most 15.

pub const fn pair_from_byte(value: u8) -> (Self, Self)

Converts a byte (u8) into a pair of nibbles, where the upper nibble is on the left and the lower nibble is on the right.

Example

use halfling::Nibble;

let byte: u8 = 0x4A;
let (upper, lower) = Nibble::pair_from_byte(byte);

assert_eq!(upper.get(), 0x4);
assert_eq!(lower.get(), 0xA);

pub const fn byte_from_pair(upper: Self, lower: Self) -> u8

Converts a pair of Nibble values into a byte, where the upper nibble is the first argument and the lower nibble is the second.

Example

use halfling::Nibble;

let upper = Nibble::new(0xB).unwrap();
let lower = Nibble::new(0x2).unwrap();
let byte = Nibble::byte_from_pair(upper, lower);

assert_eq!(byte, 0xB2);

Trait Implementations

impl Binary for Nibble

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

Formats the value using the given formatter.

impl BitAnd for Nibble

type Output = Nibble

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for Nibble

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for Nibble

type Output = Nibble

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for Nibble

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for Nibble

type Output = Nibble

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for Nibble

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for Nibble

fn clone(&self) -> Nibble

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Nibble

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

Formats the value using the given formatter.

impl Display for Nibble

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

Formats the value using the given formatter.

impl From<Nibble> for char

fn from(value: Nibble) -> Self

Converts to this type from the input type.

impl From<Nibble> for i128

fn from(value: Nibble) -> Self

Converts to this type from the input type.

impl From<Nibble> for i16

fn from(value: Nibble) -> Self

Converts to this type from the input type.

impl From<Nibble> for i32

fn from(value: Nibble) -> Self

Converts to this type from the input type.

impl From<Nibble> for i64

fn from(value: Nibble) -> Self

Converts to this type from the input type.

impl From<Nibble> for isize

fn from(value: Nibble) -> Self

Converts to this type from the input type.

impl From<Nibble> for u128

fn from(value: Nibble) -> Self

Converts to this type from the input type.

impl From<Nibble> for u16

fn from(value: Nibble) -> Self

Converts to this type from the input type.

impl From<Nibble> for u32

fn from(value: Nibble) -> Self

Converts to this type from the input type.

impl From<Nibble> for u64

fn from(value: Nibble) -> Self

Converts to this type from the input type.

impl From<Nibble> for u8

fn from(value: Nibble) -> Self

Converts to this type from the input type.

impl From<Nibble> for usize

fn from(value: Nibble) -> Self

Converts to this type from the input type.

impl LowerHex for Nibble

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

Formats the value using the given formatter.

impl Not for Nibble

type Output = Nibble

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Octal for Nibble

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

Formats the value using the given formatter.

impl Ord for Nibble

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

Restrict a value to a certain interval.

impl PartialEq for Nibble

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Nibble

fn partial_cmp(&self, other: &Nibble) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Shl<u8> for Nibble

type Output = Nibble

The resulting type after applying the << operator.

fn shl(self, rhs: u8) -> Self::Output

Performs the << operation.

impl ShlAssign<u8> for Nibble

fn shl_assign(&mut self, rhs: u8)

Performs the <<= operation.

impl Shr<u8> for Nibble

type Output = Nibble

The resulting type after applying the >> operator.

fn shr(self, rhs: u8) -> Self::Output

Performs the >> operation.

impl ShrAssign<u8> for Nibble

fn shr_assign(&mut self, rhs: u8)

Performs the >>= operation.

impl TryFrom<Nibble> for NonZeroU8

type Error = <NonZero<u8> as TryFrom<u8>>::Error

The type returned in the event of a conversion error.

fn try_from(value: Nibble) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Nibble> for i8

type Error = <i8 as TryFrom<u8>>::Error

The type returned in the event of a conversion error.

fn try_from(value: Nibble) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NonZero<u8>> for Nibble

type Error = NibbleTryFromIntError<NonZero<u8>>

The type returned in the event of a conversion error.

fn try_from(value: NonZeroU8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<bool> for Nibble

type Error = NibbleTryFromIntError<bool>

The type returned in the event of a conversion error.

fn try_from(value: bool) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<char> for Nibble

type Error = NibbleTryFromIntError<char>

The type returned in the event of a conversion error.

fn try_from(value: char) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i128> for Nibble

type Error = NibbleTryFromIntError<i128>

The type returned in the event of a conversion error.

fn try_from(value: i128) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i16> for Nibble

type Error = NibbleTryFromIntError<i16>

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for Nibble

type Error = NibbleTryFromIntError<i32>

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i64> for Nibble

type Error = NibbleTryFromIntError<i64>

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i8> for Nibble

type Error = NibbleTryFromIntError<i8>

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<isize> for Nibble

type Error = NibbleTryFromIntError<isize>

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u128> for Nibble

type Error = NibbleTryFromIntError<u128>

The type returned in the event of a conversion error.

fn try_from(value: u128) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u16> for Nibble

type Error = NibbleTryFromIntError<u16>

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for Nibble

type Error = NibbleTryFromIntError<u32>

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for Nibble

type Error = NibbleTryFromIntError<u64>

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u8> for Nibble

type Error = NibbleTryFromIntError<u8>

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for Nibble

type Error = NibbleTryFromIntError<usize>

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for Nibble

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

Formats the value using the given formatter.

impl Copy for Nibble

impl Eq for Nibble

impl StructuralPartialEq for Nibble