Struct virt_ic::chip::buttons::Button

pub struct Button { /* fields omitted */ }

A simple button

Transmit the IN signal in the OUT pin when he is down you'll need to use press() and release() to change its state

Diagram

       --------
 IN  --|1    2|-- OUT
       --------

Implementations

impl Button

pub const IN: u8

pub const OUT: u8

pub fn new() -> Self

pub fn press(&mut self)

pub fn release(&mut self)

Trait Implementations

impl Chip for Button

fn get_uuid(&self) -> u128

Give a unique id to maintain continuity when saving. This uuid must not maintain any information other that identity. When saving, this value will be used to link the traced pins to their respective chip.

fn get_type(&self) -> &str

Give a unique name for the chip struct, it must be the same for every chips of the same struct. This value will be used to rebuild the correct Struct based on this name with the help of the chip factory

fn get_pin_qty(&self) -> u8

Returns the number of pins the chip has

fn get_pin(&mut self, pin: u8) -> Result<Rc<RefCell<Pin>>, &str>

Get a pin of the chip

fn run(&mut self, _: Duration)

Runs the chip for a certain amount of time

fn save_data(&self) -> Vec<String>

Create a Vec of String that must contain every information you need to restore your chip to a certain state. This will be saved in the resulting file.

fn load_data(&mut self, chip_data: &[String])

Using the array of String you provided in save_data , you must restore the state of your chip.

fn get_pin_state(&mut self, pin: u8) -> State

Get the state of the specified Pin

fn set_pin_state(&mut self, pin: u8, state: &State)

Set the state of the specified Pin

fn save(&self) -> SavedChip

Save the chip to a SavedChip struct

fn load(&mut self, saved_chip: &SavedChip)

Restore the chip from a SavedChip struct

impl Debug for Button

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

Formats the value using the given formatter.

impl Default for Button

fn default() -> Self

Returns the "default value" for a type.