Struct State 

pub struct State { /* private fields */ }

Data structure that represents a fixed size (at runtime) array of bits, State will keep track of when bits are updated until the next call to State::tick.

State will allocate bits in multiples of 64.

Example

let mut s = State::new(2);

assert_eq!(s.len(), 64);

s.set(1,true);
assert_eq!(s.get_state(1), true);
assert_eq!(s.get_updated(1), true);

s.tick();
assert_eq!(s.get_state(1), true);
assert_eq!(s.get_updated(1), false);

Panics

Panics if you try to read or write to an index >= State::len()

let mut s = State::new(2);

s.get_state(64);

Implementations

impl State

pub fn new(n: usize) -> State

Returns a new State with n bits all of which are initialized to false.

pub fn get_state(&self, index: usize) -> bool

Returns true if the bit at index is set.

Panics

Panics if index >= State::len()

pub fn get_updated(&self, index: usize) -> bool

Returns true if the bit at index has been set since the last call to State::tick.

Panics

Panics if index >= State::len()

pub fn get_if_updated(&self, index: usize) -> Option<bool>

Returns true if the bit at index is set. Returns None if the bit has not been set since the last call to State::tick.

Panics

Panics if index >= State::len()

pub fn set(&mut self, index: usize, value: bool)

Sets the bit at index to value and keeps track that it has been updated.

Panics

Panics if index >= State::len()

pub fn set_updated(&mut self, index: usize)

Manually marks the bit at index as updated, this is equivalent to:

s.set(0,s.get_state(0));

Panics

Panics if index >= State::len()

pub fn tick(&mut self)

Resets the updated state of every bit to false.

pub fn len(&self) -> usize

Returns the number of bits in the State.

pub unsafe fn get_state_very_unsafely(&self, index: usize) -> bool

Unsafe version of State::get_state.

Safety

This function is safe if index < State::len(). Will panic in debug mode if the invariant is broken.

Annoyingly long names discourage use and make you really think about what you are doing.

pub unsafe fn get_updated_very_unsafely(&self, index: usize) -> bool

Unsafe version of State::get_updated.

Safety

This function is safe if index < State::len(). Will panic in debug mode if the invariant is broken.

Annoyingly long names discourage use and make you really think about what you are doing.

pub unsafe fn get_if_updated_very_unsafely(&self, index: usize) -> Option<bool>

Unsafe version of State::get_if_updated.

Safety

This function is safe if index < State::len(). Will panic in debug mode if the invariant is broken.

Annoyingly long names discourage use and make you really think about what you are doing.

pub unsafe fn set_very_unsafely(&mut self, index: usize, value: bool)

Unsafe version of State::set.

Safety

This function is safe if index < State::len(). Will panic in debug mode if the invariant is broken.

Annoyingly long names discourage use and make you really think about what you are doing.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Hash for State

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for State

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

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

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

impl StructuralPartialEq for State