Safe Haskell	None
Language	Haskell2010

Data.API.Types

Contents

Orphan instances

Synopsis

type API = [Thing]
data Thing
- = ThComment MDComment
- | ThNode APINode
data APINode = APINode {
- anName :: TypeName
- anComment :: MDComment
- anPrefix :: Prefix
- anSpec :: Spec
- anConvert :: Conversion
}
newtype TypeName = TypeName {
- _TypeName :: Text
}
newtype FieldName = FieldName {
- _FieldName :: Text
}
type MDComment = String
type Prefix = CI String
data Spec
- = SpNewtype SpecNewtype
- | SpRecord SpecRecord
- | SpUnion SpecUnion
- | SpEnum SpecEnum
- | SpSynonym APIType
data SpecNewtype = SpecNewtype {
- snType :: BasicType
- snFilter :: Maybe Filter
}
data SpecRecord = SpecRecord {
- srFields :: [(FieldName, FieldType)]
}
data FieldType = FieldType {
- ftType :: APIType
- ftReadOnly :: Bool
- ftDefault :: Maybe DefaultValue
- ftComment :: MDComment
}
data SpecUnion = SpecUnion {
- suFields :: [(FieldName, (APIType, MDComment))]
}
data SpecEnum = SpecEnum {
- seAlts :: [(FieldName, MDComment)]
}
type Conversion = Maybe (FieldName, FieldName)
data APIType
- = TyList APIType
- | TyMaybe APIType
- | TyName TypeName
- | TyBasic BasicType
- | TyJSON
data DefaultValue
- = DefValList
- | DefValMaybe
- | DefValString Text
- | DefValBool Bool
- | DefValInt Int
- | DefValUtc UTCTime
data BasicType
- = BTstring
- | BTbinary
- | BTbool
- | BTint
- | BTutc
data Filter
- = FtrStrg RegEx
- | FtrIntg IntRange
- | FtrUTC UTCRange
data IntRange = IntRange {
- ir_lo :: Maybe Int
- ir_hi :: Maybe Int
}
data UTCRange = UTCRange {
- ur_lo :: Maybe UTCTime
- ur_hi :: Maybe UTCTime
}
data RegEx = RegEx {
- re_text :: Text
- re_regex :: Regex
}
newtype Binary = Binary {
- _Binary :: ByteString
}
defaultValueAsJsValue :: DefaultValue -> Value
mkRegEx :: Text -> RegEx
inIntRange :: Int -> IntRange -> Bool
inUTCRange :: UTCTime -> UTCRange -> Bool
base64ToBinary :: Text -> Either String Binary

Documentation

type API = [Thing] Source #

an API spec is made up of a list of type/element specs, each specifying a Haskell type and JSON wrappers

data Thing Source #

Constructors

ThComment MDComment
ThNode APINode

Instances

Instances details

Eq Thing Source #
Instance details Defined in Data.API.Types Methods (==) :: Thing -> Thing -> Bool # (/=) :: Thing -> Thing -> Bool #
Show Thing Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> Thing -> ShowS # show :: Thing -> String # showList :: [Thing] -> ShowS #
ToJSON Thing Source #
Instance details Defined in Data.API.Types Methods toJSON :: Thing -> Value # toEncoding :: Thing -> Encoding # toJSONList :: [Thing] -> Value # toEncodingList :: [Thing] -> Encoding #
FromJSON Thing Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser Thing # parseJSONList :: Value -> Parser [Thing] #
NFData Thing Source #
Instance details Defined in Data.API.Types Methods rnf :: Thing -> () #
FromJSONWithErrs Thing Source #	Generate an API spec from the JSON
Instance details Defined in Data.API.API Methods parseJSONWithErrs :: Value -> ParserWithErrs Thing Source #
Lift Thing Source #
Instance details Defined in Data.API.Types Methods lift :: Thing -> Q Exp # liftTyped :: Thing -> Q (TExp Thing) #

data APINode Source #

Specifies an individual element/type of the API

Constructors

APINode
Fields anName :: TypeName name of Haskell type anComment :: MDComment comment describing type in Markdown anPrefix :: Prefix distinct short prefix (see below) anSpec :: Spec the type specification anConvert :: Conversion optional conversion functions

Instances

Instances details

Eq APINode Source #
Instance details Defined in Data.API.Types Methods (==) :: APINode -> APINode -> Bool # (/=) :: APINode -> APINode -> Bool #
Show APINode Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> APINode -> ShowS # show :: APINode -> String # showList :: [APINode] -> ShowS #
ToJSON APINode Source #
Instance details Defined in Data.API.Types Methods toJSON :: APINode -> Value # toEncoding :: APINode -> Encoding # toJSONList :: [APINode] -> Value # toEncodingList :: [APINode] -> Encoding #
FromJSON APINode Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser APINode # parseJSONList :: Value -> Parser [APINode] #
NFData APINode Source #
Instance details Defined in Data.API.Types Methods rnf :: APINode -> () #
Lift APINode Source #
Instance details Defined in Data.API.Types Methods lift :: APINode -> Q Exp # liftTyped :: APINode -> Q (TExp APINode) #

newtype TypeName Source #

TypeName must contain a valid Haskell type constructor

Constructors

TypeName
Fields _TypeName :: Text

Instances

Instances details

Eq TypeName Source #
Instance details Defined in Data.API.Types Methods (==) :: TypeName -> TypeName -> Bool # (/=) :: TypeName -> TypeName -> Bool #
Ord TypeName Source #
Instance details Defined in Data.API.Types Methods compare :: TypeName -> TypeName -> Ordering # (<) :: TypeName -> TypeName -> Bool # (<=) :: TypeName -> TypeName -> Bool # (>) :: TypeName -> TypeName -> Bool # (>=) :: TypeName -> TypeName -> Bool # max :: TypeName -> TypeName -> TypeName # min :: TypeName -> TypeName -> TypeName #
Show TypeName Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> TypeName -> ShowS # show :: TypeName -> String # showList :: [TypeName] -> ShowS #
IsString TypeName Source #
Instance details Defined in Data.API.Types Methods fromString :: String -> TypeName #
ToJSON TypeName Source #
Instance details Defined in Data.API.Types Methods toJSON :: TypeName -> Value # toEncoding :: TypeName -> Encoding # toJSONList :: [TypeName] -> Value # toEncodingList :: [TypeName] -> Encoding #
FromJSON TypeName Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser TypeName # parseJSONList :: Value -> Parser [TypeName] #
NFData TypeName Source #
Instance details Defined in Data.API.Types Methods rnf :: TypeName -> () #
PP TypeName Source #
Instance details Defined in Data.API.PP Methods pp :: TypeName -> String Source #
Lift TypeName Source #
Instance details Defined in Data.API.Types Methods lift :: TypeName -> Q Exp # liftTyped :: TypeName -> Q (TExp TypeName) #

newtype FieldName Source #

FieldName identifies recod fields and union alternatives must contain a valid identifier valid in Haskell and any API client wrappers (e.g., if Ruby wrappers are to be generated the names should easily map into Ruby)

Constructors

FieldName
Fields _FieldName :: Text

Instances

Instances details

Eq FieldName Source #
Instance details Defined in Data.API.Types Methods (==) :: FieldName -> FieldName -> Bool # (/=) :: FieldName -> FieldName -> Bool #
Ord FieldName Source #
Instance details Defined in Data.API.Types Methods compare :: FieldName -> FieldName -> Ordering # (<) :: FieldName -> FieldName -> Bool # (<=) :: FieldName -> FieldName -> Bool # (>) :: FieldName -> FieldName -> Bool # (>=) :: FieldName -> FieldName -> Bool # max :: FieldName -> FieldName -> FieldName # min :: FieldName -> FieldName -> FieldName #
Show FieldName Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> FieldName -> ShowS # show :: FieldName -> String # showList :: [FieldName] -> ShowS #
IsString FieldName Source #
Instance details Defined in Data.API.Types Methods fromString :: String -> FieldName #
ToJSON FieldName Source #
Instance details Defined in Data.API.Types Methods toJSON :: FieldName -> Value # toEncoding :: FieldName -> Encoding # toJSONList :: [FieldName] -> Value # toEncodingList :: [FieldName] -> Encoding #
FromJSON FieldName Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser FieldName # parseJSONList :: Value -> Parser [FieldName] #
NFData FieldName Source #
Instance details Defined in Data.API.Types Methods rnf :: FieldName -> () #
PP FieldName Source #
Instance details Defined in Data.API.PP Methods pp :: FieldName -> String Source #
Lift FieldName Source #
Instance details Defined in Data.API.Types Methods lift :: FieldName -> Q Exp # liftTyped :: FieldName -> Q (TExp FieldName) #

type MDComment = String Source #

Markdown comments are represented by strings

type Prefix = CI String Source #

a distinct case-insensitive short prefix used to form unique record field names and data constructors:

must be a valid Haskell identifier
must be unique within the API

data Spec Source #

type/element specs are either simple type isomorphisms of basic JSON types, records, unions or enumerated types

Constructors

SpNewtype SpecNewtype
SpRecord SpecRecord
SpUnion SpecUnion
SpEnum SpecEnum
SpSynonym APIType

Instances

Instances details

Eq Spec Source #
Instance details Defined in Data.API.Types Methods (==) :: Spec -> Spec -> Bool # (/=) :: Spec -> Spec -> Bool #
Show Spec Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> Spec -> ShowS # show :: Spec -> String # showList :: [Spec] -> ShowS #
ToJSON Spec Source #
Instance details Defined in Data.API.Types Methods toJSON :: Spec -> Value # toEncoding :: Spec -> Encoding # toJSONList :: [Spec] -> Value # toEncodingList :: [Spec] -> Encoding #
FromJSON Spec Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser Spec # parseJSONList :: Value -> Parser [Spec] #
NFData Spec Source #
Instance details Defined in Data.API.Types Methods rnf :: Spec -> () #
Lift Spec Source #
Instance details Defined in Data.API.Types Methods lift :: Spec -> Q Exp # liftTyped :: Spec -> Q (TExp Spec) #

data SpecNewtype Source #

SpecNewtype elements are isomorphisms of string, inetgers or booleans

Constructors

SpecNewtype
Fields snType :: BasicType snFilter :: Maybe Filter

Instances

Instances details

Eq SpecNewtype Source #
Instance details Defined in Data.API.Types Methods (==) :: SpecNewtype -> SpecNewtype -> Bool # (/=) :: SpecNewtype -> SpecNewtype -> Bool #
Show SpecNewtype Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> SpecNewtype -> ShowS # show :: SpecNewtype -> String # showList :: [SpecNewtype] -> ShowS #
ToJSON SpecNewtype Source #
Instance details Defined in Data.API.Types Methods toJSON :: SpecNewtype -> Value # toEncoding :: SpecNewtype -> Encoding # toJSONList :: [SpecNewtype] -> Value # toEncodingList :: [SpecNewtype] -> Encoding #
FromJSON SpecNewtype Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser SpecNewtype # parseJSONList :: Value -> Parser [SpecNewtype] #
NFData SpecNewtype Source #
Instance details Defined in Data.API.Types Methods rnf :: SpecNewtype -> () #
Lift SpecNewtype Source #
Instance details Defined in Data.API.Types Methods lift :: SpecNewtype -> Q Exp # liftTyped :: SpecNewtype -> Q (TExp SpecNewtype) #

data SpecRecord Source #

SpecRecord is your classsic product type.

Constructors

SpecRecord
Fields srFields :: [(FieldName, FieldType)]

Instances

Instances details

Eq SpecRecord Source #
Instance details Defined in Data.API.Types Methods (==) :: SpecRecord -> SpecRecord -> Bool # (/=) :: SpecRecord -> SpecRecord -> Bool #
Show SpecRecord Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> SpecRecord -> ShowS # show :: SpecRecord -> String # showList :: [SpecRecord] -> ShowS #
ToJSON SpecRecord Source #
Instance details Defined in Data.API.Types Methods toJSON :: SpecRecord -> Value # toEncoding :: SpecRecord -> Encoding # toJSONList :: [SpecRecord] -> Value # toEncodingList :: [SpecRecord] -> Encoding #
FromJSON SpecRecord Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser SpecRecord # parseJSONList :: Value -> Parser [SpecRecord] #
NFData SpecRecord Source #
Instance details Defined in Data.API.Types Methods rnf :: SpecRecord -> () #
Lift SpecRecord Source #
Instance details Defined in Data.API.Types Methods lift :: SpecRecord -> Q Exp # liftTyped :: SpecRecord -> Q (TExp SpecRecord) #

data FieldType Source #

In addition to the type and comment, record fields may carry a flag indicating that they are read-only, and may have a default value, which must be of a compatible type.

Constructors

FieldType
Fields ftType :: APIType ftReadOnly :: Bool ftDefault :: Maybe DefaultValue ftComment :: MDComment

Instances

Instances details

Eq FieldType Source #
Instance details Defined in Data.API.Types Methods (==) :: FieldType -> FieldType -> Bool # (/=) :: FieldType -> FieldType -> Bool #
Show FieldType Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> FieldType -> ShowS # show :: FieldType -> String # showList :: [FieldType] -> ShowS #
ToJSON FieldType Source #
Instance details Defined in Data.API.Types Methods toJSON :: FieldType -> Value # toEncoding :: FieldType -> Encoding # toJSONList :: [FieldType] -> Value # toEncodingList :: [FieldType] -> Encoding #
FromJSON FieldType Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser FieldType # parseJSONList :: Value -> Parser [FieldType] #
NFData FieldType Source #
Instance details Defined in Data.API.Types Methods rnf :: FieldType -> () #
Lift FieldType Source #
Instance details Defined in Data.API.Types Methods lift :: FieldType -> Q Exp # liftTyped :: FieldType -> Q (TExp FieldType) #

data SpecUnion Source #

SpecUnion is your classsic union type

Constructors

SpecUnion
Fields suFields :: [(FieldName, (APIType, MDComment))]

Instances

Instances details

Eq SpecUnion Source #
Instance details Defined in Data.API.Types Methods (==) :: SpecUnion -> SpecUnion -> Bool # (/=) :: SpecUnion -> SpecUnion -> Bool #
Show SpecUnion Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> SpecUnion -> ShowS # show :: SpecUnion -> String # showList :: [SpecUnion] -> ShowS #
ToJSON SpecUnion Source #
Instance details Defined in Data.API.Types Methods toJSON :: SpecUnion -> Value # toEncoding :: SpecUnion -> Encoding # toJSONList :: [SpecUnion] -> Value # toEncodingList :: [SpecUnion] -> Encoding #
FromJSON SpecUnion Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser SpecUnion # parseJSONList :: Value -> Parser [SpecUnion] #
NFData SpecUnion Source #
Instance details Defined in Data.API.Types Methods rnf :: SpecUnion -> () #
Lift SpecUnion Source #
Instance details Defined in Data.API.Types Methods lift :: SpecUnion -> Q Exp # liftTyped :: SpecUnion -> Q (TExp SpecUnion) #

data SpecEnum Source #

SpecEnum is your classic enumerated type

Constructors

SpecEnum
Fields seAlts :: [(FieldName, MDComment)]

Instances

Instances details

Eq SpecEnum Source #
Instance details Defined in Data.API.Types Methods (==) :: SpecEnum -> SpecEnum -> Bool # (/=) :: SpecEnum -> SpecEnum -> Bool #
Show SpecEnum Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> SpecEnum -> ShowS # show :: SpecEnum -> String # showList :: [SpecEnum] -> ShowS #
ToJSON SpecEnum Source #
Instance details Defined in Data.API.Types Methods toJSON :: SpecEnum -> Value # toEncoding :: SpecEnum -> Encoding # toJSONList :: [SpecEnum] -> Value # toEncodingList :: [SpecEnum] -> Encoding #
FromJSON SpecEnum Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser SpecEnum # parseJSONList :: Value -> Parser [SpecEnum] #
NFData SpecEnum Source #
Instance details Defined in Data.API.Types Methods rnf :: SpecEnum -> () #
Lift SpecEnum Source #
Instance details Defined in Data.API.Types Methods lift :: SpecEnum -> Q Exp # liftTyped :: SpecEnum -> Q (TExp SpecEnum) #

type Conversion = Maybe (FieldName, FieldName) Source #

Conversion possibly converts to an internal representation. If specified, a conversion is a pair of an injection function name and a projection function name.

data APIType Source #

Type is either a list, Maybe, a named element of the API or a basic type

Constructors

TyList APIType	list elements are types
TyMaybe APIType	Maybe elements are types
TyName TypeName	the referenced type must be defined by the API
TyBasic BasicType	a JSON string, int, bool etc.
TyJSON	a generic JSON value

Instances

Instances details

Eq APIType Source #
Instance details Defined in Data.API.Types Methods (==) :: APIType -> APIType -> Bool # (/=) :: APIType -> APIType -> Bool #
Show APIType Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> APIType -> ShowS # show :: APIType -> String # showList :: [APIType] -> ShowS #
IsString APIType Source #	It is sometimes helpful to write a type name directly as a string
Instance details Defined in Data.API.Types Methods fromString :: String -> APIType #
ToJSON APIType Source #
Instance details Defined in Data.API.Types Methods toJSON :: APIType -> Value # toEncoding :: APIType -> Encoding # toJSONList :: [APIType] -> Value # toEncodingList :: [APIType] -> Encoding #
FromJSON APIType Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser APIType # parseJSONList :: Value -> Parser [APIType] #
NFData APIType Source #
Instance details Defined in Data.API.Types Methods rnf :: APIType -> () #
PP APIType Source #
Instance details Defined in Data.API.PP Methods pp :: APIType -> String Source #
Lift APIType Source #
Instance details Defined in Data.API.Types Methods lift :: APIType -> Q Exp # liftTyped :: APIType -> Q (TExp APIType) #

data DefaultValue Source #

A default value for a field

Constructors

DefValList
DefValMaybe
DefValString Text
DefValBool Bool
DefValInt Int
DefValUtc UTCTime

Instances

Instances details

Eq DefaultValue Source #
Instance details Defined in Data.API.Types Methods (==) :: DefaultValue -> DefaultValue -> Bool # (/=) :: DefaultValue -> DefaultValue -> Bool #
Show DefaultValue Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> DefaultValue -> ShowS # show :: DefaultValue -> String # showList :: [DefaultValue] -> ShowS #
ToJSON DefaultValue Source #
Instance details Defined in Data.API.Types Methods toJSON :: DefaultValue -> Value # toEncoding :: DefaultValue -> Encoding # toJSONList :: [DefaultValue] -> Value # toEncodingList :: [DefaultValue] -> Encoding #
FromJSON DefaultValue Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser DefaultValue # parseJSONList :: Value -> Parser [DefaultValue] #
NFData DefaultValue Source #
Instance details Defined in Data.API.Types Methods rnf :: DefaultValue -> () #
PP DefaultValue Source #
Instance details Defined in Data.API.PP Methods pp :: DefaultValue -> String Source #
Lift DefaultValue Source #
Instance details Defined in Data.API.Types Methods lift :: DefaultValue -> Q Exp # liftTyped :: DefaultValue -> Q (TExp DefaultValue) #

data BasicType Source #

the basic JSON types (N.B., no floating point numbers, yet)

Constructors

BTstring	a JSON UTF-8 string
BTbinary	a base-64-encoded byte string
BTbool	a JSON bool
BTint	a JSON integral number
BTutc	a JSON UTC string

Instances

Instances details

Eq BasicType Source #
Instance details Defined in Data.API.Types Methods (==) :: BasicType -> BasicType -> Bool # (/=) :: BasicType -> BasicType -> Bool #
Show BasicType Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> BasicType -> ShowS # show :: BasicType -> String # showList :: [BasicType] -> ShowS #
ToJSON BasicType Source #
Instance details Defined in Data.API.Types Methods toJSON :: BasicType -> Value # toEncoding :: BasicType -> Encoding # toJSONList :: [BasicType] -> Value # toEncodingList :: [BasicType] -> Encoding #
FromJSON BasicType Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser BasicType # parseJSONList :: Value -> Parser [BasicType] #
NFData BasicType Source #
Instance details Defined in Data.API.Types Methods rnf :: BasicType -> () #
PP BasicType Source #
Instance details Defined in Data.API.PP Methods pp :: BasicType -> String Source #
Lift BasicType Source #
Instance details Defined in Data.API.Types Methods lift :: BasicType -> Q Exp # liftTyped :: BasicType -> Q (TExp BasicType) #

data Filter Source #

Constructors

FtrStrg RegEx
FtrIntg IntRange
FtrUTC UTCRange

Instances

Instances details

Eq Filter Source #
Instance details Defined in Data.API.Types Methods (==) :: Filter -> Filter -> Bool # (/=) :: Filter -> Filter -> Bool #
Show Filter Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> Filter -> ShowS # show :: Filter -> String # showList :: [Filter] -> ShowS #
ToJSON Filter Source #
Instance details Defined in Data.API.Types Methods toJSON :: Filter -> Value # toEncoding :: Filter -> Encoding # toJSONList :: [Filter] -> Value # toEncodingList :: [Filter] -> Encoding #
FromJSON Filter Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser Filter # parseJSONList :: Value -> Parser [Filter] #
NFData Filter Source #
Instance details Defined in Data.API.Types Methods rnf :: Filter -> () #
Lift Filter Source #
Instance details Defined in Data.API.Types Methods lift :: Filter -> Q Exp # liftTyped :: Filter -> Q (TExp Filter) #

data IntRange Source #

Constructors

IntRange
Fields ir_lo :: Maybe Int ir_hi :: Maybe Int

Instances

Instances details

Eq IntRange Source #
Instance details Defined in Data.API.Types Methods (==) :: IntRange -> IntRange -> Bool # (/=) :: IntRange -> IntRange -> Bool #
Show IntRange Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> IntRange -> ShowS # show :: IntRange -> String # showList :: [IntRange] -> ShowS #
ToJSON IntRange Source #
Instance details Defined in Data.API.Types Methods toJSON :: IntRange -> Value # toEncoding :: IntRange -> Encoding # toJSONList :: [IntRange] -> Value # toEncodingList :: [IntRange] -> Encoding #
FromJSON IntRange Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser IntRange # parseJSONList :: Value -> Parser [IntRange] #
NFData IntRange Source #
Instance details Defined in Data.API.Types Methods rnf :: IntRange -> () #
Lift IntRange Source #
Instance details Defined in Data.API.Types Methods lift :: IntRange -> Q Exp # liftTyped :: IntRange -> Q (TExp IntRange) #

data UTCRange Source #

Constructors

UTCRange
Fields ur_lo :: Maybe UTCTime ur_hi :: Maybe UTCTime

Instances

Instances details

Eq UTCRange Source #
Instance details Defined in Data.API.Types Methods (==) :: UTCRange -> UTCRange -> Bool # (/=) :: UTCRange -> UTCRange -> Bool #
Show UTCRange Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> UTCRange -> ShowS # show :: UTCRange -> String # showList :: [UTCRange] -> ShowS #
ToJSON UTCRange Source #
Instance details Defined in Data.API.Types Methods toJSON :: UTCRange -> Value # toEncoding :: UTCRange -> Encoding # toJSONList :: [UTCRange] -> Value # toEncodingList :: [UTCRange] -> Encoding #
FromJSON UTCRange Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser UTCRange # parseJSONList :: Value -> Parser [UTCRange] #
NFData UTCRange Source #
Instance details Defined in Data.API.Types Methods rnf :: UTCRange -> () #
Lift UTCRange Source #
Instance details Defined in Data.API.Types Methods lift :: UTCRange -> Q Exp # liftTyped :: UTCRange -> Q (TExp UTCRange) #

data RegEx Source #

Constructors

RegEx
Fields re_text :: Text re_regex :: Regex

Instances

Instances details

Eq RegEx Source #
Instance details Defined in Data.API.Types Methods (==) :: RegEx -> RegEx -> Bool # (/=) :: RegEx -> RegEx -> Bool #
Show RegEx Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> RegEx -> ShowS # show :: RegEx -> String # showList :: [RegEx] -> ShowS #
ToJSON RegEx Source #
Instance details Defined in Data.API.Types Methods toJSON :: RegEx -> Value # toEncoding :: RegEx -> Encoding # toJSONList :: [RegEx] -> Value # toEncodingList :: [RegEx] -> Encoding #
FromJSON RegEx Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser RegEx # parseJSONList :: Value -> Parser [RegEx] #
NFData RegEx Source #
Instance details Defined in Data.API.Types Methods rnf :: RegEx -> () #
Lift RegEx Source #
Instance details Defined in Data.API.Types Methods lift :: RegEx -> Q Exp # liftTyped :: RegEx -> Q (TExp RegEx) #

newtype Binary Source #

Binary data is represented in JSON format as a base64-encoded string

Constructors

Binary
Fields _Binary :: ByteString

Instances

Instances details

Eq Binary Source #
Instance details Defined in Data.API.Types Methods (==) :: Binary -> Binary -> Bool # (/=) :: Binary -> Binary -> Bool #
Ord Binary Source #
Instance details Defined in Data.API.Types Methods compare :: Binary -> Binary -> Ordering # (<) :: Binary -> Binary -> Bool # (<=) :: Binary -> Binary -> Bool # (>) :: Binary -> Binary -> Bool # (>=) :: Binary -> Binary -> Bool # max :: Binary -> Binary -> Binary # min :: Binary -> Binary -> Binary #
Show Binary Source #
Instance details Defined in Data.API.Types Methods showsPrec :: Int -> Binary -> ShowS # show :: Binary -> String # showList :: [Binary] -> ShowS #
Arbitrary Binary Source #
Instance details Defined in Data.API.Types Methods arbitrary :: Gen Binary # shrink :: Binary -> [Binary] #
ToJSON Binary Source #
Instance details Defined in Data.API.Types Methods toJSON :: Binary -> Value # toEncoding :: Binary -> Encoding # toJSONList :: [Binary] -> Value # toEncodingList :: [Binary] -> Encoding #
FromJSON Binary Source #
Instance details Defined in Data.API.Types Methods parseJSON :: Value -> Parser Binary # parseJSONList :: Value -> Parser [Binary] #
NFData Binary Source #
Instance details Defined in Data.API.Types Methods rnf :: Binary -> () #
SafeCopy Binary Source #
Instance details Defined in Data.API.Types Methods version :: Version Binary # kind :: Kind Binary # getCopy :: Contained (Get Binary) # putCopy :: Binary -> Contained Put # internalConsistency :: Consistency Binary # objectProfile :: Profile Binary # errorTypeName :: Proxy Binary -> String #
Serialise Binary Source #
Instance details Defined in Data.API.Types Methods encode :: Binary -> Encoding # decode :: Decoder s Binary # encodeList :: [Binary] -> Encoding # decodeList :: Decoder s [Binary] #
Example Binary Source #
Instance details Defined in Data.API.Tools.Example Methods example :: Gen Binary Source #
FromJSONWithErrs Binary Source #
Instance details Defined in Data.API.JSON Methods parseJSONWithErrs :: Value -> ParserWithErrs Binary Source #

defaultValueAsJsValue :: DefaultValue -> Value Source #

Convert a default value to an Aeson Value. This differs from toJSON as it will not round-trip with fromJSON: UTC default values are turned into strings.

mkRegEx :: Text -> RegEx Source #

inIntRange :: Int -> IntRange -> Bool Source #

inUTCRange :: UTCTime -> UTCRange -> Bool Source #

base64ToBinary :: Text -> Either String Binary Source #

Orphan instances

Arbitrary Text Source #
Instance details Methods arbitrary :: Gen Text # shrink :: Text -> [Text] #
ToJSON s => ToJSON (CI s) Source #
Instance details Methods toJSON :: CI s -> Value # toEncoding :: CI s -> Encoding # toJSONList :: [CI s] -> Value # toEncodingList :: [CI s] -> Encoding #
FromJSON s => FromJSON (CI s) Source #
Instance details Methods parseJSON :: Value -> Parser (CI s) # parseJSONList :: Value -> Parser [CI s] #