Copyright	(C) 2016 Jason Johnson
License	BSD-style (see the file LICENSE)
Maintainer	Jason Johnson <jason.johnson.081@gmail.com>
Stability	experimental
Portability	TBD
Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.HodaTime.LocalTime

Contents

Types
Constructors
Exceptions

Description

An LocalTime represents a time of day, with no reference to a particular calendar, time zone or date. This module contains constructors and functions for working with LocalTime.

Normalization

A clock time can be from 00:00:00.000 to 23:59:59.99.. Adding 1 minute to 23:59:00 will cause it to roll over to 00:00:00.

Synopsis

data LocalTime
class HasLocalTime lt where
- hour :: Functor f => (Hour -> f Hour) -> lt -> f lt
- minute :: Functor f => (Minute -> f Minute) -> lt -> f lt
- second :: Functor f => (Second -> f Second) -> lt -> f lt
- nanosecond :: Functor f => (Nanosecond -> f Nanosecond) -> lt -> f lt
type Hour = Int
type Minute = Int
type Second = Int
type Nanosecond = Int
localTime :: MonadThrow m => Hour -> Minute -> Second -> Nanosecond -> m LocalTime
data InvalidHourException
data InvalidMinuteException
data InvalidSecondException
data InvalidNanoSecondException

Types

data LocalTime Source #

Represents a specific time of day with no reference to any calendar, date or time zone.

Instances

Instances details

Show LocalTime Source #
Instance details Defined in Data.HodaTime.CalendarDateTime.Internal Methods showsPrec :: Int -> LocalTime -> ShowS # show :: LocalTime -> String # showList :: [LocalTime] -> ShowS #
Eq LocalTime Source #
Instance details Defined in Data.HodaTime.CalendarDateTime.Internal Methods (==) :: LocalTime -> LocalTime -> Bool # (/=) :: LocalTime -> LocalTime -> Bool #
Ord LocalTime Source #
Instance details Defined in Data.HodaTime.CalendarDateTime.Internal Methods compare :: LocalTime -> LocalTime -> Ordering # (<) :: LocalTime -> LocalTime -> Bool # (<=) :: LocalTime -> LocalTime -> Bool # (>) :: LocalTime -> LocalTime -> Bool # (>=) :: LocalTime -> LocalTime -> Bool # max :: LocalTime -> LocalTime -> LocalTime # min :: LocalTime -> LocalTime -> LocalTime #
HasLocalTime LocalTime Source #
Instance details Defined in Data.HodaTime.LocalTime.Internal Methods hour :: Functor f => (Hour -> f Hour) -> LocalTime -> f LocalTime Source # minute :: Functor f => (Minute -> f Minute) -> LocalTime -> f LocalTime Source # second :: Functor f => (Second -> f Second) -> LocalTime -> f LocalTime Source # nanosecond :: Functor f => (Nanosecond -> f Nanosecond) -> LocalTime -> f LocalTime Source #

class HasLocalTime lt where Source #

Methods

hour :: Functor f => (Hour -> f Hour) -> lt -> f lt Source #

Lens for the hour component of the LocalTime

minute :: Functor f => (Minute -> f Minute) -> lt -> f lt Source #

Lens for the minute component of the LocalTime

second :: Functor f => (Second -> f Second) -> lt -> f lt Source #

Lens for the second component of the LocalTime

nanosecond :: Functor f => (Nanosecond -> f Nanosecond) -> lt -> f lt Source #

Lens for the nanoseconds component of the LocalTime. NOTE: no effort is made to detect nano overflow. They will simply roll over on overflow without affecting the rest of the time.

Instances

Instances details

HasLocalTime LocalTime Source #
Instance details Defined in Data.HodaTime.LocalTime.Internal Methods hour :: Functor f => (Hour -> f Hour) -> LocalTime -> f LocalTime Source # minute :: Functor f => (Minute -> f Minute) -> LocalTime -> f LocalTime Source # second :: Functor f => (Second -> f Second) -> LocalTime -> f LocalTime Source # nanosecond :: Functor f => (Nanosecond -> f Nanosecond) -> LocalTime -> f LocalTime Source #
IsCalendar cal => HasLocalTime (CalendarDateTime cal) Source #
Instance details Defined in Data.HodaTime.LocalTime.Internal Methods hour :: Functor f => (Hour -> f Hour) -> CalendarDateTime cal -> f (CalendarDateTime cal) Source # minute :: Functor f => (Minute -> f Minute) -> CalendarDateTime cal -> f (CalendarDateTime cal) Source # second :: Functor f => (Second -> f Second) -> CalendarDateTime cal -> f (CalendarDateTime cal) Source # nanosecond :: Functor f => (Nanosecond -> f Nanosecond) -> CalendarDateTime cal -> f (CalendarDateTime cal) Source #

type Hour = Int Source #

type Minute = Int Source #

type Second = Int Source #

type Nanosecond = Int Source #

Constructors

localTime :: MonadThrow m => Hour -> Minute -> Second -> Nanosecond -> m LocalTime Source #

Create a new LocalTime from an hour, minute, second and nanosecond if values are valid

Exceptions

data InvalidHourException Source #

Given hour was not valid

Instances

Instances details

Exception InvalidHourException Source #
Instance details Defined in Data.HodaTime.LocalTime.Internal Methods toException :: InvalidHourException -> SomeException # fromException :: SomeException -> Maybe InvalidHourException # displayException :: InvalidHourException -> String #
Show InvalidHourException Source #
Instance details Defined in Data.HodaTime.LocalTime.Internal Methods showsPrec :: Int -> InvalidHourException -> ShowS # show :: InvalidHourException -> String # showList :: [InvalidHourException] -> ShowS #

data InvalidMinuteException Source #

Given minute was not valid

Instances

Instances details

Exception InvalidMinuteException Source #
Instance details Defined in Data.HodaTime.LocalTime.Internal Methods toException :: InvalidMinuteException -> SomeException # fromException :: SomeException -> Maybe InvalidMinuteException # displayException :: InvalidMinuteException -> String #
Show InvalidMinuteException Source #
Instance details Defined in Data.HodaTime.LocalTime.Internal Methods showsPrec :: Int -> InvalidMinuteException -> ShowS # show :: InvalidMinuteException -> String # showList :: [InvalidMinuteException] -> ShowS #

data InvalidSecondException Source #

Given second was not valid

Instances

Instances details

Exception InvalidSecondException Source #
Instance details Defined in Data.HodaTime.LocalTime.Internal Methods toException :: InvalidSecondException -> SomeException # fromException :: SomeException -> Maybe InvalidSecondException # displayException :: InvalidSecondException -> String #
Show InvalidSecondException Source #
Instance details Defined in Data.HodaTime.LocalTime.Internal Methods showsPrec :: Int -> InvalidSecondException -> ShowS # show :: InvalidSecondException -> String # showList :: [InvalidSecondException] -> ShowS #

data InvalidNanoSecondException Source #

Given nanosecond was not valid

Instances

Instances details

Exception InvalidNanoSecondException Source #
Instance details Defined in Data.HodaTime.LocalTime.Internal Methods toException :: InvalidNanoSecondException -> SomeException # fromException :: SomeException -> Maybe InvalidNanoSecondException # displayException :: InvalidNanoSecondException -> String #
Show InvalidNanoSecondException Source #
Instance details Defined in Data.HodaTime.LocalTime.Internal Methods showsPrec :: Int -> InvalidNanoSecondException -> ShowS # show :: InvalidNanoSecondException -> String # showList :: [InvalidNanoSecondException] -> ShowS #