Data.Timeout

Documentation

data TimedOut

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

Defined in Data.Timeout

Methods

(==) :: TimedOut -> TimedOut -> Bool

(/=) :: TimedOut -> TimedOut -> Bool

Show TimedOut

Defined in Data.Timeout

Methods

showsPrec :: Int -> TimedOut -> ShowS

show :: TimedOut -> String

showList :: [TimedOut] -> ShowS

Exception TimedOut

Defined in Data.Timeout

Methods

toException :: TimedOut -> SomeException

fromException :: SomeException -> Maybe TimedOut

displayException :: TimedOut -> String

data TimeoutUnit

Timeout unit.

Constructors

NanoSecond

MicroSecond

MilliSecond

Second

Minute

Hour

Day

Week

Instances

Bounded TimeoutUnit

Defined in Data.Timeout

Methods

minBound :: TimeoutUnit

maxBound :: TimeoutUnit

Enum TimeoutUnit

Defined in Data.Timeout

Methods

succ :: TimeoutUnit -> TimeoutUnit

pred :: TimeoutUnit -> TimeoutUnit

toEnum :: Int -> TimeoutUnit

fromEnum :: TimeoutUnit -> Int

enumFrom :: TimeoutUnit -> [TimeoutUnit]

enumFromThen :: TimeoutUnit -> TimeoutUnit -> [TimeoutUnit]

enumFromTo :: TimeoutUnit -> TimeoutUnit -> [TimeoutUnit]

enumFromThenTo :: TimeoutUnit -> TimeoutUnit -> TimeoutUnit -> [TimeoutUnit]

Eq TimeoutUnit

Defined in Data.Timeout

Methods

(==) :: TimeoutUnit -> TimeoutUnit -> Bool

(/=) :: TimeoutUnit -> TimeoutUnit -> Bool

Ord TimeoutUnit

Defined in Data.Timeout

Methods

compare :: TimeoutUnit -> TimeoutUnit -> Ordering

(<) :: TimeoutUnit -> TimeoutUnit -> Bool

(<=) :: TimeoutUnit -> TimeoutUnit -> Bool

(>) :: TimeoutUnit -> TimeoutUnit -> Bool

(>=) :: TimeoutUnit -> TimeoutUnit -> Bool

max :: TimeoutUnit -> TimeoutUnit -> TimeoutUnit

min :: TimeoutUnit -> TimeoutUnit -> TimeoutUnit

Read TimeoutUnit

Defined in Data.Timeout

Methods

readsPrec :: Int -> ReadS TimeoutUnit

readList :: ReadS [TimeoutUnit]

readPrec :: ReadPrec TimeoutUnit

readListPrec :: ReadPrec [TimeoutUnit]

Show TimeoutUnit

Defined in Data.Timeout

Methods

showsPrec :: Int -> TimeoutUnit -> ShowS

show :: TimeoutUnit -> String

showList :: [TimeoutUnit] -> ShowS

Ix TimeoutUnit

Defined in Data.Timeout

Methods

range :: (TimeoutUnit, TimeoutUnit) -> [TimeoutUnit]

index :: (TimeoutUnit, TimeoutUnit) -> TimeoutUnit -> Int

unsafeIndex :: (TimeoutUnit, TimeoutUnit) -> TimeoutUnit -> Int

inRange :: (TimeoutUnit, TimeoutUnit) -> TimeoutUnit -> Bool

rangeSize :: (TimeoutUnit, TimeoutUnit) -> Int

unsafeRangeSize :: (TimeoutUnit, TimeoutUnit) -> Int

Printable TimeoutUnit

Defined in Data.Timeout

Methods

print :: Printer p => TimeoutUnit -> p

Textual TimeoutUnit

Defined in Data.Timeout

Methods

textual :: (Monad μ, CharParsing μ) => μ TimeoutUnit

aTimeoutUnit :: Proxy TimeoutUnit

TimeoutUnit proxy value.

timeoutUnitNanos :: TimeoutUnit -> Word64

Amount of nanoseconds in a timeout unit.

newtype Timeout

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

Instances

Bounded Timeout

Defined in Data.Timeout

Methods

minBound :: Timeout

maxBound :: Timeout

Enum Timeout

Defined in Data.Timeout

Methods

succ :: Timeout -> Timeout

pred :: Timeout -> Timeout

toEnum :: Int -> Timeout

fromEnum :: Timeout -> Int

enumFrom :: Timeout -> [Timeout]

enumFromThen :: Timeout -> Timeout -> [Timeout]

enumFromTo :: Timeout -> Timeout -> [Timeout]

enumFromThenTo :: Timeout -> Timeout -> Timeout -> [Timeout]

Eq Timeout

Defined in Data.Timeout

Methods

(==) :: Timeout -> Timeout -> Bool

(/=) :: Timeout -> Timeout -> Bool

Integral Timeout

Defined in Data.Timeout

Methods

quot :: Timeout -> Timeout -> Timeout

rem :: Timeout -> Timeout -> Timeout

div :: Timeout -> Timeout -> Timeout

mod :: Timeout -> Timeout -> Timeout

quotRem :: Timeout -> Timeout -> (Timeout, Timeout)

divMod :: Timeout -> Timeout -> (Timeout, Timeout)

toInteger :: Timeout -> Integer

Num Timeout

Defined in Data.Timeout

Methods

(+) :: Timeout -> Timeout -> Timeout

(-) :: Timeout -> Timeout -> Timeout

(*) :: Timeout -> Timeout -> Timeout

negate :: Timeout -> Timeout

abs :: Timeout -> Timeout

signum :: Timeout -> Timeout

fromInteger :: Integer -> Timeout

Ord Timeout

Defined in Data.Timeout

Methods

compare :: Timeout -> Timeout -> Ordering

(<) :: Timeout -> Timeout -> Bool

(<=) :: Timeout -> Timeout -> Bool

(>) :: Timeout -> Timeout -> Bool

(>=) :: Timeout -> Timeout -> Bool

max :: Timeout -> Timeout -> Timeout

min :: Timeout -> Timeout -> Timeout

Read Timeout

Defined in Data.Timeout

Methods

readsPrec :: Int -> ReadS Timeout

readList :: ReadS [Timeout]

readPrec :: ReadPrec Timeout

readListPrec :: ReadPrec [Timeout]

Real Timeout

Defined in Data.Timeout

Methods

toRational :: Timeout -> Rational

Show Timeout

Defined in Data.Timeout

Methods

showsPrec :: Int -> Timeout -> ShowS

show :: Timeout -> String

showList :: [Timeout] -> ShowS

Ix Timeout

Defined in Data.Timeout

Methods

range :: (Timeout, Timeout) -> [Timeout]

index :: (Timeout, Timeout) -> Timeout -> Int

unsafeIndex :: (Timeout, Timeout) -> Timeout -> Int

inRange :: (Timeout, Timeout) -> Timeout -> Bool

rangeSize :: (Timeout, Timeout) -> Int

unsafeRangeSize :: (Timeout, Timeout) -> Int

Printable Timeout

Defined in Data.Timeout

Methods

print :: Printer p => Timeout -> p

Textual Timeout

Defined in Data.Timeout

Methods

textual :: (Monad μ, CharParsing μ) => μ Timeout

aTimeout :: Proxy Timeout

Timeout proxy value.

(#) :: Word64 -> TimeoutUnit -> Timeout infix 9

Convert the given number of timeout units to Timeout.

(#>) :: Timeout -> TimeoutUnit -> Word64 infix 8

Extract number of units (rounding up).

(#<) :: Timeout -> TimeoutUnit -> Word64 infix 8

Extract number of units (rounding down).

instantly :: Timeout

Zero timeout. The event in question should occur immediately.