unix-time
Safe HaskellNone
LanguageHaskell2010

Data.UnixTime

Synopsis

Data structure

data UnixTime Source #

Data structure for Unix time.

Please note that this uses GHC-derived Eq and Ord instances. Notably

>>> UnixTime 1 0 > UnixTime 0 999999999
True

You should instead use UnixDiffTime along with its helpers such as microSecondsToUnixDiffTime which will ensure that such unusual values are never created.

Constructors

UnixTime 

Fields

Instances

Instances details
Binary UnixTime Source # 
Instance details

Defined in Data.UnixTime.Types

Methods

put :: UnixTime -> Put

get :: Get UnixTime

putList :: [UnixTime] -> Put

Eq UnixTime Source # 
Instance details

Defined in Data.UnixTime.Types

Methods

(==) :: UnixTime -> UnixTime -> Bool

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

Ord UnixTime Source # 
Instance details

Defined in Data.UnixTime.Types

Methods

compare :: UnixTime -> UnixTime -> Ordering

(<) :: UnixTime -> UnixTime -> Bool

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

(>) :: UnixTime -> UnixTime -> Bool

(>=) :: UnixTime -> UnixTime -> Bool

max :: UnixTime -> UnixTime -> UnixTime

min :: UnixTime -> UnixTime -> UnixTime

Storable UnixTime Source # 
Instance details

Defined in Data.UnixTime.Types

Methods

sizeOf :: UnixTime -> Int

alignment :: UnixTime -> Int

peekElemOff :: Ptr UnixTime -> Int -> IO UnixTime

pokeElemOff :: Ptr UnixTime -> Int -> UnixTime -> IO ()

peekByteOff :: Ptr b -> Int -> IO UnixTime

pokeByteOff :: Ptr b -> Int -> UnixTime -> IO ()

peek :: Ptr UnixTime -> IO UnixTime

poke :: Ptr UnixTime -> UnixTime -> IO ()

Generic UnixTime Source # 
Instance details

Defined in Data.UnixTime.Types

Associated Types

type Rep UnixTime 
Instance details

Defined in Data.UnixTime.Types

type Rep UnixTime = D1 ('MetaData "UnixTime" "Data.UnixTime.Types" "unix-time-0.6.0-EQ1YiZQhI7aDF6KQzQPEAo" 'False) (C1 ('MetaCons "UnixTime" 'PrefixI 'True) (S1 ('MetaSel ('Just "utSeconds") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 CTime) :*: S1 ('MetaSel ('Just "utMicroSeconds") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int32)))

Methods

from :: UnixTime -> Rep UnixTime x

to :: Rep UnixTime x -> UnixTime

Show UnixTime Source # 
Instance details

Defined in Data.UnixTime.Types

Methods

showsPrec :: Int -> UnixTime -> ShowS

show :: UnixTime -> String

showList :: [UnixTime] -> ShowS

type Rep UnixTime Source # 
Instance details

Defined in Data.UnixTime.Types

type Rep UnixTime = D1 ('MetaData "UnixTime" "Data.UnixTime.Types" "unix-time-0.6.0-EQ1YiZQhI7aDF6KQzQPEAo" 'False) (C1 ('MetaCons "UnixTime" 'PrefixI 'True) (S1 ('MetaSel ('Just "utSeconds") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 CTime) :*: S1 ('MetaSel ('Just "utMicroSeconds") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int32)))

Getting time

getUnixTime :: IO UnixTime Source #

Get current UnixTime from OS.

Parsing and formatting time

parseUnixTime :: Format -> ByteString -> UnixTime Source #

Parsing ByteString to UnixTime interpreting as localtime. This is a wrapper for strptime_l(). Many implementations of strptime_l() do not support %Z and some implementations of strptime_l() do not support %z, either. utMicroSeconds is always set to 0.

The result is unspecified if parsing fails. Use parseUnixTimeMaybe to detect failures.

This depends on the TZ environment variable but is a pure function. So, the result may be shared even if TZ is changed later.

parseUnixTimeGMT :: Format -> ByteString -> UnixTime Source #

Parsing ByteString to UnixTime interpreting as GMT. This is a wrapper for strptime_l(). utMicroSeconds is always set to 0.

The result is unspecified if parsing fails. Use parseUnixTimeGMTMaybe to detect failures.

>>> parseUnixTimeGMT webDateFormat "Thu, 01 Jan 1970 00:00:00 GMT"
UnixTime {utSeconds = 0, utMicroSeconds = 0}

parseUnixTimeMaybe :: Format -> ByteString -> Maybe UnixTime Source #

Like parseUnixTime but returns Nothing unless the entire input matches the format.

parseUnixTimeGMTMaybe :: Format -> ByteString -> Maybe UnixTime Source #

Like parseUnixTimeGMT but returns Nothing unless the entire input matches the format.

>>> parseUnixTimeGMTMaybe webDateFormat "Thu, 01 Jan 1970 00:00:00 GMT"
Just (UnixTime {utSeconds = 0, utMicroSeconds = 0})
>>> parseUnixTimeGMTMaybe webDateFormat "garbage"
Nothing

formatUnixTime :: Format -> UnixTime -> IO ByteString Source #

Formatting UnixTime to ByteString in local time. This is a wrapper for strftime_l(). utMicroSeconds is ignored. The result depends on the TZ environment variable.

formatUnixTimeGMT :: Format -> UnixTime -> ByteString Source #

Formatting UnixTime to ByteString in GMT. This is a wrapper for strftime_l(). utMicroSeconds is ignored.

>>> formatUnixTimeGMT webDateFormat $ UnixTime 0 0
"Thu, 01 Jan 1970 00:00:00 GMT"
>>> let ut = UnixTime 100 200
>>> let str = formatUnixTimeGMT "%s" ut
>>> let ut' = parseUnixTimeGMT "%s" str
>>> ((==) `on` utSeconds) ut ut'
True
>>> ((==) `on` utMicroSeconds) ut ut'
False

Format

type Format = ByteString Source #

Format of the strptime()/strftime() style.

webDateFormat :: Format Source #

Format for web (RFC 2616). The value is "%a, %d %b %Y %H:%M:%S GMT". This should be used with formatUnixTimeGMT and parseUnixTimeGMT.

mailDateFormat :: Format Source #

Format for e-mail (RFC 5322). The value is "%a, %d %b %Y %H:%M:%S %z". This should be used with formatUnixTime and parseUnixTime.

Difference time

data UnixDiffTime Source #

Data structure for UnixTime diff.

The functions in this library normalize values so that both fields have the same sign and |udtMicroSeconds| < 1000000. Use microSecondsToUnixDiffTime to create values. The derived Eq and Ord instances are meaningful only for normalized values.

Constructors

UnixDiffTime 

Fields

Instances

Instances details
Eq UnixDiffTime Source # 
Instance details

Defined in Data.UnixTime.Types

Methods

(==) :: UnixDiffTime -> UnixDiffTime -> Bool

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

Ord UnixDiffTime Source # 
Instance details

Defined in Data.UnixTime.Types

Num UnixDiffTime

Arithmetic operations where (1::UnixDiffTime) means 1 second.

>>> (3 :: UnixDiffTime) + 2
UnixDiffTime {udtSeconds = 5, udtMicroSeconds = 0}
>>> (2 :: UnixDiffTime) - 5
UnixDiffTime {udtSeconds = -3, udtMicroSeconds = 0}
>>> (3 :: UnixDiffTime) * 2
UnixDiffTime {udtSeconds = 6, udtMicroSeconds = 0}
>>> microSecondsToUnixDiffTime (1500000 :: Int) * microSecondsToUnixDiffTime (1500000 :: Int)
UnixDiffTime {udtSeconds = 2, udtMicroSeconds = 250000}
>>> negate (microSecondsToUnixDiffTime (500000 :: Int))
UnixDiffTime {udtSeconds = 0, udtMicroSeconds = -500000}
Instance details

Defined in Data.UnixTime.Diff

Real UnixDiffTime 
Instance details

Defined in Data.UnixTime.Diff

Methods

toRational :: UnixDiffTime -> Rational

Show UnixDiffTime Source # 
Instance details

Defined in Data.UnixTime.Types

Methods

showsPrec :: Int -> UnixDiffTime -> ShowS

show :: UnixDiffTime -> String

showList :: [UnixDiffTime] -> ShowS

diffUnixTime :: UnixTime -> UnixTime -> UnixDiffTime Source #

Calculating difference between two UnixTime.

>>> UnixTime 100 2000 `diffUnixTime` UnixTime 98 2100
UnixDiffTime {udtSeconds = 1, udtMicroSeconds = 999900}

addUnixDiffTime :: UnixTime -> UnixDiffTime -> UnixTime Source #

Adding difference to UnixTime.

>>> UnixTime 100 2000 `addUnixDiffTime` microSecondsToUnixDiffTime ((-1003000) :: Int)
UnixTime {utSeconds = 98, utMicroSeconds = 999000}

secondsToUnixDiffTime :: Integral a => a -> UnixDiffTime Source #

Creating difference from seconds.

>>> secondsToUnixDiffTime (100 :: Int)
UnixDiffTime {udtSeconds = 100, udtMicroSeconds = 0}

microSecondsToUnixDiffTime :: Integral a => a -> UnixDiffTime Source #

Creating difference from micro seconds.

>>> microSecondsToUnixDiffTime (12345678 :: Int)
UnixDiffTime {udtSeconds = 12, udtMicroSeconds = 345678}
>>> microSecondsToUnixDiffTime ((-12345678) :: Int)
UnixDiffTime {udtSeconds = -12, udtMicroSeconds = -345678}
>>> microSecondsToUnixDiffTime ((-345678) :: Int)
UnixDiffTime {udtSeconds = 0, udtMicroSeconds = -345678}

Translating time

fromEpochTime :: EpochTime -> UnixTime Source #

From EpochTime to UnixTime setting utMicroSeconds to 0.

toEpochTime :: UnixTime -> EpochTime Source #

From UnixTime to EpochTime ignoring utMicroSeconds.