Hercules.API.DayOfWeek

A day of week type. Integer representations are not used in the API, but are provided for convenience and will not change.

Documentation

data DayOfWeek

Day of week representation used in the API.

Constructors

Mon

Tue

Wed

Thu

Fri

Sat

Sun

Instances

FromJSON DayOfWeek

Defined in Hercules.API.DayOfWeek

Methods

parseJSON :: Value -> Parser DayOfWeek

parseJSONList :: Value -> Parser [DayOfWeek]

ToJSON DayOfWeek

Defined in Hercules.API.DayOfWeek

Methods

toJSON :: DayOfWeek -> Value

toEncoding :: DayOfWeek -> Encoding

toJSONList :: [DayOfWeek] -> Value

toEncodingList :: [DayOfWeek] -> Encoding

Generic DayOfWeek

Defined in Hercules.API.DayOfWeek

Associated Types

type Rep DayOfWeek :: Type -> Type

Methods

from :: DayOfWeek -> Rep DayOfWeek x

to :: Rep DayOfWeek x -> DayOfWeek

Show DayOfWeek

Defined in Hercules.API.DayOfWeek

Methods

showsPrec :: Int -> DayOfWeek -> ShowS

show :: DayOfWeek -> String

showList :: [DayOfWeek] -> ShowS

NFData DayOfWeek

Defined in Hercules.API.DayOfWeek

Methods

rnf :: DayOfWeek -> ()

Eq DayOfWeek

Defined in Hercules.API.DayOfWeek

Methods

(==) :: DayOfWeek -> DayOfWeek -> Bool

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

ToSchema DayOfWeek

Defined in Hercules.API.DayOfWeek

Methods

declareNamedSchema :: Proxy DayOfWeek -> Declare (Definitions Schema) NamedSchema

ToSchema DayOfWeek

Defined in Hercules.API.DayOfWeek

Methods

declareNamedSchema :: Proxy DayOfWeek -> Declare (Definitions Schema) NamedSchema

type Rep DayOfWeek

Defined in Hercules.API.DayOfWeek

type Rep DayOfWeek = D1 ('MetaData "DayOfWeek" "Hercules.API.DayOfWeek" "hercules-ci-api-core-0.1.6.0-inplace" 'False) ((C1 ('MetaCons "Mon" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Tue" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Wed" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Thu" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Fri" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Sat" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Sun" 'PrefixI 'False) (U1 :: Type -> Type))))

Conversions for time package

toTime :: DayOfWeek -> DayOfWeek

Conversion to time package representation.

fromTime :: DayOfWeek -> DayOfWeek

Conversion from time package representation.

Optional, stable, opinionated integer conversions

toNum :: Num n => DayOfWeek -> n

Conversion to integers where Mon -> 1, Sun -> 7

fromNumMaybe :: (Num n, Eq n) => n -> Maybe DayOfWeek

Conversion from integers where 1 -> Just Mon, 7 -> Just Sun, outside of 1..7 -> Nothing

fromNum :: (Integral n, Eq n) => n -> DayOfWeek

Conversion from integers where {...,-7,0,7,...} -> Just Sun, {...,-6,1,8,...} -> Just Mon, etc.

Requires a sensible implementation of the Integral mod method that returns non-negative numbers. Integer, Int, Int8, etc are ok. So is the Word family of types, though beware of minBound overflows.