Struct BintCell 

pub struct BintCell {
    pub cell: Cell<u8>,
    pub boundary: u8,
}

BintCell: A bounded integer captured in a Cell.

Allows for Bint functionality in a single entity.

Usage:

use bint::BintCell;

let b = BintCell::new(6);

b.down();
assert_eq!(5, b.value());

b.up();
b.up();
b.up();
assert_eq!(2, b.value());

Fields

cell: Cell<u8>

boundary: u8

Implementations

impl BintCell

pub fn new(boundary: u8) -> BintCell

use bint::BintCell;

let b = BintCell::new(6);
assert_eq!(0, b.value());
assert_eq!(6, b.boundary);

pub fn new_with_value(boundary: u8, value: u8) -> BintCell

use bint::BintCell;

let b = BintCell::new_with_value(6, 6);
assert_eq!(0, b.value());
assert_eq!(6, b.boundary);

let b = BintCell::new_with_value(6, 3);
assert_eq!(3, b.value());
assert_eq!(6, b.boundary);

pub fn up(&self)

use bint::BintCell;

let b = BintCell::new(6);

b.up();
assert_eq!(1, b.value());

b.up();
assert_eq!(2, b.value());

pub fn up_x(&self, x: u8)

use bint::BintCell;

let b = BintCell::new(6);

b.up_x(3);
assert_eq!(3, b.value());

pub fn down(&self)

use bint::BintCell;

let b = BintCell::new(6);

b.down();
assert_eq!(5, b.value());

b.down();
assert_eq!(4, b.value());

pub fn down_x(&self, x: u8)

use bint::BintCell;

let b = BintCell::new(6);

b.down_x(2);
assert_eq!(4, b.value());

pub fn reset(&self)

use bint::BintCell;

let b = BintCell::new_with_value(8, 5);
b.reset();

assert_eq!(0, b.value());

pub fn set(&self, value: u8)

use bint::BintCell;

let b = BintCell::new(8);
b.set(5);

assert_eq!(5, b.value());

pub fn value(&self) -> u8

Trait Implementations

impl Clone for BintCell

fn clone(&self) -> BintCell

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BintCell

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

Formats the value using the given formatter.

impl Default for BintCell

fn default() -> Self

Defaults to the maximum value of an unsigned 8 integer.

use bint::BintCell;

let b = BintCell::default();

for _ in 0..u8::MAX {
    b.up()
}

for _ in 0..u8::MAX {
    b.down()
}

assert_eq!(b.value(), 0)

impl Display for BintCell

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

Formats the value using the given formatter.

impl From<Bint> for BintCell

fn from(cell: Bint) -> Self

use bint::{Bint, BintCell};

let bint = Bint::new_with_value(8, 3);
let expected = BintCell::new_with_value(8, 3);

assert_eq!(expected, BintCell::from(bint));

impl From<BintCell> for Bint

fn from(cell: BintCell) -> Self

use bint::{Bint, BintCell};

let cell = BintCell::new_with_value(8, 3);
let expected = Bint {
    value: cell.value(),
    boundary: cell.boundary,
};

assert_eq!(expected, Bint::from(cell));

impl Ord for BintCell

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

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

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

impl StructuralPartialEq for BintCell