Struct ByteBase2

pub struct ByteBase2 { /* private fields */ }

A binary representation of a byte.

Implementations

impl ByteBase2

pub fn ones(&self) -> usize

Returns how many ones there is in this byte.

Example

use binary_byte::ByteBase2;
 
let byte = ByteBase2::from_dec(15);
assert_eq!(byte.ones(), 4);

pub fn iter(&self) -> impl Iterator<Item = bool>

Returns an iterator over this byte’s bits.

Yields first the least significative bit and last the most significative one.

Example

use binary_byte::ByteBase2;
 
let byte = ByteBase2::from_string("00000011").unwrap();
let mut byte_iter = byte.iter();
assert_eq!(byte_iter.next(), Some(true));
assert_eq!(byte_iter.next(), Some(true));
assert_eq!(byte_iter.next(), Some(false));

pub fn from_string(pattern: impl Into<String>) -> Result<Self, InvalidPattern>

Tries to create a ByteBase2 from a string representing an 8 bit binary number.

Errors

Returns an Err(InvalidPattern) if the pattern length is not exactly 8 or if any of its characters is different of ‘1’ or ‘0’.

Example

use binary_byte::{ ByteBase2, InvalidPattern };
 
assert!(ByteBase2::from_string("01111001").is_ok());
assert_eq!(ByteBase2::from_string("12001101"), Err(InvalidPattern));
assert_eq!(ByteBase2::from_string("101010100"), Err(InvalidPattern));
assert_eq!(ByteBase2::from_string("1010"), Err(InvalidPattern));

pub fn from_dec(input: u8) -> Self

Creates a ByteBase2 object from an u8 value.

Example

use binary_byte::ByteBase2;
 
let byte = ByteBase2::from_dec(15);
assert_eq!(format!("{:?}", byte), "00001111".to_string());

pub fn as_dec(&self) -> u8

Converts a ByteBase2 number to its decimal representation.

Example

use binary_byte::ByteBase2;
 
let byte = ByteBase2::from_string("00001000").unwrap();
assert_eq!(byte.as_dec(), 8);

Trait Implementations

impl Debug for ByteBase2

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

Formats the value using the given formatter.

impl Index<usize> for ByteBase2

Access the bits in this byte.

Index 0 access the least significative bit.

type Output = bool

The returned type after indexing.

fn index(&self, idx: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for ByteBase2

Mutably access the bits in this byte.

Index 0 access the least significative bit.

fn index_mut(&mut self, idx: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl PartialEq for ByteBase2

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