Struct gear_combos::Gear

pub struct Gear { /* fields omitted */ }

Represents a gear that can cycle through states. It keeps track of the states available and which state it is currently in.

Methods

impl Gear

pub fn new(size: usize) -> Gear

Returns a new gear with an initial state of 0. Populates states with a vector starting from 0, until the end of 'size' - 1.

Example

use gear_combos::Gear;
let gear = Gear::new(2);

assert_eq!(&vec![0,1], gear.states());
assert_eq!(0, gear.state());

pub fn next(&mut self) -> bool

Increments the state if it's not at the end.

pub fn cycle(&mut self) -> bool

Increments the state and resets if at end. Returns true if the gear has increments. Returns false if the gear has been reset to 0;

pub fn end(&self) -> bool

Returns whether the gear is at it's last state.

pub fn reset(&mut self)

Sets the gears state back to 0.

pub fn states(&self) -> &Vec<i32>

Returns a reference to the entire states of the gear.

pub fn state(&self) -> i32

Returns the current state of the gear.