Struct DrainableBintCell 

pub struct DrainableBintCell {
    pub capacity: Cell<usize>,
    /* private fields */
}

Version of a BintCell that can only be called a limited number of times, after which it returns none.

Fields

capacity: Cell<usize>

Implementations

impl DrainableBintCell

pub fn new(boundary: u8, capacity: usize) -> DrainableBintCell

pub fn new_with_value( boundary: u8, capacity: usize, value: u8, ) -> DrainableBintCell

use bint::DrainableBintCell;

let b = DrainableBintCell::new_with_value(4, 4, 3);

assert_eq!(3, b.value());
assert_eq!(2, b.down().unwrap());
assert_eq!(1, b.down().unwrap());
assert_eq!(0, b.down().unwrap());
assert_eq!(3, b.down().unwrap());
assert!(b.down().is_none());

pub fn down(&self) -> Option<u8>

use bint::DrainableBintCell;

let b = DrainableBintCell::new(4, 8);

assert_eq!(3, b.down().unwrap());
assert_eq!(2, b.down().unwrap());
assert_eq!(1, b.down().unwrap());
assert_eq!(0, b.down().unwrap());
assert_eq!(3, b.down().unwrap());
assert_eq!(2, b.down().unwrap());
assert_eq!(1, b.down().unwrap());
assert_eq!(0, b.down().unwrap());
assert!(b.down().is_none());

pub fn down_x(&self, x: u8) -> Option<u8>

use bint::DrainableBintCell;

let b = DrainableBintCell::new(4, 4);

assert_eq!(2, b.down_x(2).unwrap());
assert_eq!(0, b.down_x(2).unwrap());
assert!(b.down_x(2).is_none());

pub fn drain(&self) -> Option<usize>

Removes one from the capacity.

pub fn has_capacity(&self) -> bool

use bint::DrainableBintCell;

let b = DrainableBintCell::new(1, 1);

assert!(b.has_capacity());
assert_eq!(0, b.up().unwrap());
assert!(!b.has_capacity());

pub fn up(&self) -> Option<u8>

use bint::DrainableBintCell;

let b = DrainableBintCell::new(4, 4);

assert_eq!(1, b.up().unwrap());
assert_eq!(2, b.up().unwrap());
assert_eq!(3, b.up().unwrap());
assert_eq!(0, b.up().unwrap());
assert!(b.down().is_none());

pub fn up_x(&self, x: u8) -> Option<u8>

use bint::DrainableBintCell;

let b = DrainableBintCell::new(4, 4);

assert_eq!(3, b.up_x(3).unwrap());
assert_eq!(0, b.up_x(1).unwrap());
assert!(b.up_x(2).is_none());

pub fn value(&self) -> u8

Trait Implementations

impl Clone for DrainableBintCell

fn clone(&self) -> DrainableBintCell

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DrainableBintCell

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

Formats the value using the given formatter.

impl From<&DrainableBintCell> for Bint

fn from(cell: &DrainableBintCell) -> Self

use bint::{Bint, DrainableBintCell};

let bint_cell = DrainableBintCell::new_with_value(8, 8, 3);
let expected = Bint::new_with_value(8, 3);

assert_eq!(expected, Bint::from(&bint_cell));

impl From<&DrainableBintCell> for BintCell

fn from(cell: &DrainableBintCell) -> Self

use bint::{BintCell, DrainableBintCell};

let bint_cell = DrainableBintCell::new_with_value(8, 8, 3);
let expected = BintCell::new_with_value(8, 3);

assert_eq!(expected, BintCell::from(&bint_cell));

impl From<DrainableBintCell> for Bint

fn from(cell: DrainableBintCell) -> Self

use bint::{Bint, DrainableBintCell};

let bint_cell = DrainableBintCell::new_with_value(8, 8, 3);
let expected = Bint::new_with_value(8, 3);

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

impl From<DrainableBintCell> for BintCell

fn from(cell: DrainableBintCell) -> Self

use bint::{BintCell, DrainableBintCell};

let bint_cell = DrainableBintCell::new_with_value(8, 8, 3);
let expected = BintCell::new_with_value(8, 3);

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

impl Ord for DrainableBintCell

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

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

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

impl StructuralPartialEq for DrainableBintCell