Data.HodaTime.Offset

An Offset is a period of time offset from UTC time. This module contains constructors and functions for working with Offsets.

Clamping

An offset must be between 18 hours and -18 hours (inclusive). If you go outside this range the functions will clamp to the nearest value.

Types

data Offset

An Offset from UTC in seconds.

Instances

Eq Offset

Methods

(==) :: Offset -> Offset -> Bool

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

Ord Offset

Methods

compare :: Offset -> Offset -> Ordering

(<) :: Offset -> Offset -> Bool

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

(>) :: Offset -> Offset -> Bool

(>=) :: Offset -> Offset -> Bool

max :: Offset -> Offset -> Offset

min :: Offset -> Offset -> Offset

Show Offset

Methods

showsPrec :: Int -> Offset -> ShowS

show :: Offset -> String

showList :: [Offset] -> ShowS

Constructors

fromSeconds :: Integral a => a -> Offset

Create an Offset of (clamped) s seconds.

fromMinutes :: Integral a => a -> Offset

Create an Offset of (clamped) m minutes.

fromHours :: Integral a => a -> Offset

Create an Offset of (clamped) h hours.

Lenses

seconds :: Functor f => (Int -> f Int) -> Offset -> f Offset

Lens for the seconds component of the Offset

minutes :: Functor f => (Int -> f Int) -> Offset -> f Offset

Lens for the minutes component of the Offset

hours :: Functor f => (Int -> f Int) -> Offset -> f Offset

Lens for the hours component of the Offset

Math

add :: Offset -> Offset -> Offset

Add one Offset to another NOTE: if the result of the addition is outside the accepted range it will be clamped

minus :: Offset -> Offset -> Offset

Subtract one Offset to another. NOTE: See add above