Struct nibbler::nibble::Nibble

pub struct Nibble { /* fields omitted */ }

A struct containing 4 boolean values. Each value represents a bit.

• bit0 = 2^0 (least significant bit)
• bit1 = 2^1
• bit2 = 2^2
• bit3 = 2^3 (most significant bit)

Implementations

impl Nibble

pub fn new(bit0: bool, bit1: bool, bit2: bool, bit3: bool) -> Nibble

Returns a new instance of the nibble struct.

Example Usage:

use nibbler::traits::Nib;
use nibbler::nibble::Nibble;
let mut nib = Nibble::new(false, false, false, false);
assert_eq!(0, nib.into());
nib = Nibble::new(true, false, false, false);
assert_eq!(1, nib.into());
assert_eq!(nib.b0(), true);
assert_eq!(nib.i0(), 1);
nib = Nibble::new(false, true, false, false);
assert_eq!(2, nib.into());
assert_eq!(nib.b0(), false);
assert_eq!(nib.b1(), true);
assert_eq!(nib.i0(), 0);
assert_eq!(nib.i1(), 1);
nib = Nibble::new(false, false, true, false);
assert_eq!(4, nib.into());
assert_eq!(nib.b0(), false);
assert_eq!(nib.b1(), false);
assert_eq!(nib.b2(), true);
assert_eq!(nib.b3(), false);
assert_eq!(nib.i0(), 0);
assert_eq!(nib.i1(), 0);
assert_eq!(nib.i2(), 1);
assert_eq!(nib.i3(), 0);
nib = Nibble::new(false, false, false, true);
assert_eq!(8, nib.into());
assert_eq!(nib.b0(), false);
assert_eq!(nib.b1(), false);
assert_eq!(nib.b2(), false);
assert_eq!(nib.b3(), true);
assert_eq!(nib.i0(), 0);
assert_eq!(nib.i1(), 0);
assert_eq!(nib.i2(), 0);
assert_eq!(nib.i3(), 1);
nib = Nibble::new(true, true, true, true);
assert_eq!(15, nib.into());

Realistically, or pragmatically, using true/false statements to initialize an instance is not doable.

use nibbler::traits::Nib;
use nibbler::nibble::Nibble;
let val: u8 = 15;
let mut nib = Nibble::from(val);
assert_eq!(15, nib.into());
assert_eq!(nib.b0(), true);
assert_eq!(nib.b1(), true);
assert_eq!(nib.b2(), true);
assert_eq!(nib.b3(), true);
assert_eq!(nib.i0(), 1);
assert_eq!(nib.i1(), 1);
assert_eq!(nib.i2(), 1);
assert_eq!(nib.i3(), 1);
let val: u8 = 16;
//nib = Nibble::from(val) // this fails.
// 16 is 2^4, which is 5-bits; a nibble is only 4-bits.
// 15 is the largest 2^3 value possible (4-bits).

Opposed to the core struct here, Nibble, you probably want Nibbles, which will turn any {u, i}{8, 16, 32, 64} into a Vec, and convert back and forth.

Trait Implementations

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 Copy for Nibble

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 u64

fn from(n: Nibble) -> u64

Performs the conversion.

impl From<Nibble> for i64

fn from(n: Nibble) -> i64

Performs the conversion.

impl From<Nibble> for u32

fn from(n: Nibble) -> u32

Performs the conversion.

impl From<Nibble> for i32

fn from(n: Nibble) -> i32

Performs the conversion.

impl From<Nibble> for u16

fn from(n: Nibble) -> u16

Performs the conversion.

impl From<Nibble> for i16

fn from(n: Nibble) -> i16

Performs the conversion.

impl From<Nibble> for u8

fn from(n: Nibble) -> u8

Performs the conversion.

impl From<Nibble> for i8

fn from(n: Nibble) -> i8

Performs the conversion.

impl From<i16> for Nibble

fn from(val: i16) -> Nibble

Performs the conversion.

impl From<i32> for Nibble

fn from(val: i32) -> Nibble

Performs the conversion.

impl From<i64> for Nibble

fn from(val: i64) -> Nibble

Performs the conversion.

impl From<i8> for Nibble

fn from(val: i8) -> Nibble

Performs the conversion.

impl From<u16> for Nibble

fn from(val: u16) -> Nibble

Performs the conversion.

impl From<u32> for Nibble

fn from(val: u32) -> Nibble

Performs the conversion.

impl From<u64> for Nibble

fn from(val: u64) -> Nibble

Performs the conversion.

impl From<u8> for Nibble

fn from(val: u8) -> Nibble

Performs the conversion.

impl Nib for Nibble

fn ival(&self) -> u8

Returns an unsigned 8-bit integer value.

fn hval(&self) -> &'static str

Returns a hex-dec string.

fn b0(&self) -> bool

Gets the least significant bit, 2^0

fn b1(&self) -> bool

Gets the 2^1 value.

fn b2(&self) -> bool

Gets the 2^2 value.

fn b3(&self) -> bool

Gets the most sigificant bit, 2^3

fn i0(&self) -> u8

Gets the least significant bit, 2^0, as an integer (1 or 0).

fn i1(&self) -> u8

Gets the 2^1 value as an integer (1 or 0).

fn i2(&self) -> u8

Gets the 2^2 value as an integer (1 or 0).

fn i3(&self) -> u8

Gets the most significant bit, 2^3, as an integer (1 or 0).

fn as_bit_str_le(&self) -> String

Gets the bit string, Little Endian, MSBit on left, LSBit on right.

fn as_bit_str_be(&self) -> String

Gets the bit string, Big Endian, LSBit on left, MSBit on right.

impl PartialEq<Nibble> 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: &Nibble) -> bool

This method tests for !=.

impl StructuralPartialEq for Nibble