BishBosh.Property.Switchable

AUTHOR

Dr. Alistair Ward

DESCRIPTION

Defines a class to which IO data-types which can be switched between binary states, can conform.

Type-classes

class Switchable a where

For data which operate like binary switches.

Minimal complete definition

on, toggle, isOn

Methods

on

Arguments

:: IO a

Returns a switch in the on state, regardless of any previous state.

toggle

Arguments

:: a

-> IO a

Switch the binary state.

switchOff

Arguments

:: a

-> IO a

Turn the switch off, which has no effect if already in the off state.

isOn

Arguments

:: a

-> Bool

Predicate: whether the switch is currently in the on state.

isOff

Arguments

:: a

-> Bool

Predicate: whether the switch is currently in the off state.

Instances

Switchable StopWatch

Defined in BishBosh.Time.StopWatch

Methods

on :: IO StopWatch

toggle :: StopWatch -> IO StopWatch

switchOff :: StopWatch -> IO StopWatch

isOn :: StopWatch -> Bool

isOff :: StopWatch -> Bool

Switchable GameClock

Defined in BishBosh.Time.GameClock

Methods

on :: IO GameClock

toggle :: GameClock -> IO GameClock

switchOff :: GameClock -> IO GameClock

isOn :: GameClock -> Bool

isOff :: GameClock -> Bool

Functions

flick :: Switchable switchable => Int -> switchable -> IO switchable

Toggle the switch the specified number of times.