Safe Haskell	None

Data.Timeout

Synopsis

Documentation

data TimedOut Source

Exception that is raised when an operation times out. Not used by the package itself, it is here so that users don't need to roll their own exception type every time.

Constructors

TimedOut

Instances

Eq TimedOut
Show TimedOut
Typeable TimedOut
Exception TimedOut

data TimeoutUnit Source

Timeout unit.

Constructors

NanoSecond
MicroSecond
MilliSecond
Second
Minute
Hour
Day
Week

Instances

Bounded TimeoutUnit
Enum TimeoutUnit
Eq TimeoutUnit
Ord TimeoutUnit
Read TimeoutUnit
Show TimeoutUnit
Ix TimeoutUnit
Typeable TimeoutUnit
Printable TimeoutUnit
Textual TimeoutUnit

aTimeoutUnit :: Proxy TimeoutUnit Source

TimeoutUnit proxy value.

timeoutUnitNanos :: TimeoutUnit -> Word64 Source

Amount of nanoseconds in a timeout unit.

newtype Timeout Source

Timeout in nanoseconds. The Printable instance renders timeouts as series of AmountUnit tokens, e.g.

      toString (1 # Day + 1500 # MilliSecond) = "1d1s500ms"

The full list of timeout unit abbreviations:

NanoSecond - ns
MicroSecond - us
MilliSecond - ms
Second - s
Minute - m
Hour - h
Day - d
Week - w

The Textual instance accepts this syntax and allows decimal fractions to be used as amounts:

     fmap toString (fromStringAs aTimeout "1m1.5s0.2us") = Just "1m1s500ms200ns"

Constructors

Timeout Word64

aTimeout :: Proxy Timeout Source

Timeout proxy value.

(#) :: Word64 -> TimeoutUnit -> Timeout Source

Convert the given number of timeout units to Timeout.

(#>) :: Timeout -> TimeoutUnit -> Word64 Source

Extract number of units (rounding up).

(#<) :: Timeout -> TimeoutUnit -> Word64 Source

Extract number of units (rounding down).

instantly :: Timeout Source

Zero timeout. The event in question should occur immediately.

Bounded Timeout
Enum Timeout
Eq Timeout
Integral Timeout
Num Timeout
Ord Timeout
Read Timeout
Real Timeout
Show Timeout
Ix Timeout
Typeable Timeout
Printable Timeout
Textual Timeout