Data.API.Types

Documentation

type API = [Thing]

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

data Thing

Constructors

ThComment MDComment

ThNode APINode

Instances

FromJSON Thing

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser Thing

parseJSONList :: Value -> Parser [Thing]

ToJSON Thing

Defined in Data.API.Types

Methods

toJSON :: Thing -> Value

toEncoding :: Thing -> Encoding

toJSONList :: [Thing] -> Value

toEncodingList :: [Thing] -> Encoding

FromJSONWithErrs Thing

Generate an API spec from the JSON

Defined in Data.API.API

Methods

parseJSONWithErrs :: Value -> ParserWithErrs Thing

Show Thing

Defined in Data.API.Types

Methods

showsPrec :: Int -> Thing -> ShowS

show :: Thing -> String

showList :: [Thing] -> ShowS

NFData Thing

Defined in Data.API.Types

Methods

rnf :: Thing -> ()

Eq Thing

Defined in Data.API.Types

Methods

(==) :: Thing -> Thing -> Bool

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

Lift Thing

Defined in Data.API.Types

Methods

lift :: Quote m => Thing -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Thing -> Code m Thing

data APINode

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

FromJSON APINode

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser APINode

parseJSONList :: Value -> Parser [APINode]

ToJSON APINode

Defined in Data.API.Types

Methods

toJSON :: APINode -> Value

toEncoding :: APINode -> Encoding

toJSONList :: [APINode] -> Value

toEncodingList :: [APINode] -> Encoding

Show APINode

Defined in Data.API.Types

Methods

showsPrec :: Int -> APINode -> ShowS

show :: APINode -> String

showList :: [APINode] -> ShowS

NFData APINode

Defined in Data.API.Types

Methods

rnf :: APINode -> ()

Eq APINode

Defined in Data.API.Types

Methods

(==) :: APINode -> APINode -> Bool

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

Lift APINode

Defined in Data.API.Types

Methods

lift :: Quote m => APINode -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => APINode -> Code m APINode

newtype TypeName

TypeName must contain a valid Haskell type constructor

Constructors

TypeName

Fields

• _TypeName :: Text

Instances

FromJSON TypeName

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser TypeName

parseJSONList :: Value -> Parser [TypeName]

ToJSON TypeName

Defined in Data.API.Types

Methods

toJSON :: TypeName -> Value

toEncoding :: TypeName -> Encoding

toJSONList :: [TypeName] -> Value

toEncodingList :: [TypeName] -> Encoding

PP TypeName

Defined in Data.API.PP

Methods

pp :: TypeName -> String

IsString TypeName

Defined in Data.API.Types

Methods

fromString :: String -> TypeName

Show TypeName

Defined in Data.API.Types

Methods

showsPrec :: Int -> TypeName -> ShowS

show :: TypeName -> String

showList :: [TypeName] -> ShowS

NFData TypeName

Defined in Data.API.Types

Methods

rnf :: TypeName -> ()

Eq TypeName

Defined in Data.API.Types

Methods

(==) :: TypeName -> TypeName -> Bool

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

Ord TypeName

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

Lift TypeName

Defined in Data.API.Types

Methods

lift :: Quote m => TypeName -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => TypeName -> Code m TypeName

newtype FieldName

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

FromJSON FieldName

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser FieldName

parseJSONList :: Value -> Parser [FieldName]

ToJSON FieldName

Defined in Data.API.Types

Methods

toJSON :: FieldName -> Value

toEncoding :: FieldName -> Encoding

toJSONList :: [FieldName] -> Value

toEncodingList :: [FieldName] -> Encoding

PP FieldName

Defined in Data.API.PP

Methods

pp :: FieldName -> String

IsString FieldName

Defined in Data.API.Types

Methods

fromString :: String -> FieldName

Show FieldName

Defined in Data.API.Types

Methods

showsPrec :: Int -> FieldName -> ShowS

show :: FieldName -> String

showList :: [FieldName] -> ShowS

NFData FieldName

Defined in Data.API.Types

Methods

rnf :: FieldName -> ()

Eq FieldName

Defined in Data.API.Types

Methods

(==) :: FieldName -> FieldName -> Bool

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

Ord FieldName

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

Lift FieldName

Defined in Data.API.Types

Methods

lift :: Quote m => FieldName -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => FieldName -> Code m FieldName

type MDComment = String

Markdown comments are represented by strings

type Prefix = CI String

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

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

FromJSON Spec

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser Spec

parseJSONList :: Value -> Parser [Spec]

ToJSON Spec

Defined in Data.API.Types

Methods

toJSON :: Spec -> Value

toEncoding :: Spec -> Encoding

toJSONList :: [Spec] -> Value

toEncodingList :: [Spec] -> Encoding

Show Spec

Defined in Data.API.Types

Methods

showsPrec :: Int -> Spec -> ShowS

show :: Spec -> String

showList :: [Spec] -> ShowS

NFData Spec

Defined in Data.API.Types

Methods

rnf :: Spec -> ()

Eq Spec

Defined in Data.API.Types

Methods

(==) :: Spec -> Spec -> Bool

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

Lift Spec

Defined in Data.API.Types

Methods

lift :: Quote m => Spec -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Spec -> Code m Spec

data SpecNewtype

SpecNewtype elements are isomorphisms of string, inetgers or booleans

Constructors

SpecNewtype

Fields

• snType :: BasicType
• snFilter :: Maybe Filter

Instances

FromJSON SpecNewtype

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser SpecNewtype

parseJSONList :: Value -> Parser [SpecNewtype]

ToJSON SpecNewtype

Defined in Data.API.Types

Methods

toJSON :: SpecNewtype -> Value

toEncoding :: SpecNewtype -> Encoding

toJSONList :: [SpecNewtype] -> Value

toEncodingList :: [SpecNewtype] -> Encoding

Show SpecNewtype

Defined in Data.API.Types

Methods

showsPrec :: Int -> SpecNewtype -> ShowS

show :: SpecNewtype -> String

showList :: [SpecNewtype] -> ShowS

NFData SpecNewtype

Defined in Data.API.Types

Methods

rnf :: SpecNewtype -> ()

Eq SpecNewtype

Defined in Data.API.Types

Methods

(==) :: SpecNewtype -> SpecNewtype -> Bool

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

Lift SpecNewtype

Defined in Data.API.Types

Methods

lift :: Quote m => SpecNewtype -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => SpecNewtype -> Code m SpecNewtype

data SpecRecord

SpecRecord is your classsic product type.

Constructors

SpecRecord

Fields

• srFields :: [(FieldName, FieldType)]

Instances

FromJSON SpecRecord

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser SpecRecord

parseJSONList :: Value -> Parser [SpecRecord]

ToJSON SpecRecord

Defined in Data.API.Types

Methods

toJSON :: SpecRecord -> Value

toEncoding :: SpecRecord -> Encoding

toJSONList :: [SpecRecord] -> Value

toEncodingList :: [SpecRecord] -> Encoding

Show SpecRecord

Defined in Data.API.Types

Methods

showsPrec :: Int -> SpecRecord -> ShowS

show :: SpecRecord -> String

showList :: [SpecRecord] -> ShowS

NFData SpecRecord

Defined in Data.API.Types

Methods

rnf :: SpecRecord -> ()

Eq SpecRecord

Defined in Data.API.Types

Methods

(==) :: SpecRecord -> SpecRecord -> Bool

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

Lift SpecRecord

Defined in Data.API.Types

Methods

lift :: Quote m => SpecRecord -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => SpecRecord -> Code m SpecRecord

data FieldType

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

FromJSON FieldType

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser FieldType

parseJSONList :: Value -> Parser [FieldType]

ToJSON FieldType

Defined in Data.API.Types

Methods

toJSON :: FieldType -> Value

toEncoding :: FieldType -> Encoding

toJSONList :: [FieldType] -> Value

toEncodingList :: [FieldType] -> Encoding

Show FieldType

Defined in Data.API.Types

Methods

showsPrec :: Int -> FieldType -> ShowS

show :: FieldType -> String

showList :: [FieldType] -> ShowS

NFData FieldType

Defined in Data.API.Types

Methods

rnf :: FieldType -> ()

Eq FieldType

Defined in Data.API.Types

Methods

(==) :: FieldType -> FieldType -> Bool

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

Lift FieldType

Defined in Data.API.Types

Methods

lift :: Quote m => FieldType -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => FieldType -> Code m FieldType

data SpecUnion

SpecUnion is your classsic union type

Constructors

SpecUnion

Fields

• suFields :: [(FieldName, (APIType, MDComment))]

Instances

FromJSON SpecUnion

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser SpecUnion

parseJSONList :: Value -> Parser [SpecUnion]

ToJSON SpecUnion

Defined in Data.API.Types

Methods

toJSON :: SpecUnion -> Value

toEncoding :: SpecUnion -> Encoding

toJSONList :: [SpecUnion] -> Value

toEncodingList :: [SpecUnion] -> Encoding

Show SpecUnion

Defined in Data.API.Types

Methods

showsPrec :: Int -> SpecUnion -> ShowS

show :: SpecUnion -> String

showList :: [SpecUnion] -> ShowS

NFData SpecUnion

Defined in Data.API.Types

Methods

rnf :: SpecUnion -> ()

Eq SpecUnion

Defined in Data.API.Types

Methods

(==) :: SpecUnion -> SpecUnion -> Bool

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

Lift SpecUnion

Defined in Data.API.Types

Methods

lift :: Quote m => SpecUnion -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => SpecUnion -> Code m SpecUnion

data SpecEnum

SpecEnum is your classic enumerated type

Constructors

SpecEnum

Fields

• seAlts :: [(FieldName, MDComment)]

Instances

FromJSON SpecEnum

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser SpecEnum

parseJSONList :: Value -> Parser [SpecEnum]

ToJSON SpecEnum

Defined in Data.API.Types

Methods

toJSON :: SpecEnum -> Value

toEncoding :: SpecEnum -> Encoding

toJSONList :: [SpecEnum] -> Value

toEncodingList :: [SpecEnum] -> Encoding

Show SpecEnum

Defined in Data.API.Types

Methods

showsPrec :: Int -> SpecEnum -> ShowS

show :: SpecEnum -> String

showList :: [SpecEnum] -> ShowS

NFData SpecEnum

Defined in Data.API.Types

Methods

rnf :: SpecEnum -> ()

Eq SpecEnum

Defined in Data.API.Types

Methods

(==) :: SpecEnum -> SpecEnum -> Bool

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

Lift SpecEnum

Defined in Data.API.Types

Methods

lift :: Quote m => SpecEnum -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => SpecEnum -> Code m SpecEnum

type Conversion = Maybe (FieldName, FieldName)

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

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

FromJSON APIType

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser APIType

parseJSONList :: Value -> Parser [APIType]

ToJSON APIType

Defined in Data.API.Types

Methods

toJSON :: APIType -> Value

toEncoding :: APIType -> Encoding

toJSONList :: [APIType] -> Value

toEncodingList :: [APIType] -> Encoding

PP APIType

Defined in Data.API.PP

Methods

pp :: APIType -> String

IsString APIType

It is sometimes helpful to write a type name directly as a string

Defined in Data.API.Types

Methods

fromString :: String -> APIType

Show APIType

Defined in Data.API.Types

Methods

showsPrec :: Int -> APIType -> ShowS

show :: APIType -> String

showList :: [APIType] -> ShowS

NFData APIType

Defined in Data.API.Types

Methods

rnf :: APIType -> ()

Eq APIType

Defined in Data.API.Types

Methods

(==) :: APIType -> APIType -> Bool

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

Lift APIType

Defined in Data.API.Types

Methods

lift :: Quote m => APIType -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => APIType -> Code m APIType

data DefaultValue

A default value for a field

Constructors

DefValList

DefValMaybe

DefValString Text

DefValBool Bool

DefValInt Int

DefValUtc UTCTime

Instances

FromJSON DefaultValue

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser DefaultValue

parseJSONList :: Value -> Parser [DefaultValue]

ToJSON DefaultValue

Defined in Data.API.Types

Methods

toJSON :: DefaultValue -> Value

toEncoding :: DefaultValue -> Encoding

toJSONList :: [DefaultValue] -> Value

toEncodingList :: [DefaultValue] -> Encoding

PP DefaultValue

Defined in Data.API.PP

Methods

pp :: DefaultValue -> String

Show DefaultValue

Defined in Data.API.Types

Methods

showsPrec :: Int -> DefaultValue -> ShowS

show :: DefaultValue -> String

showList :: [DefaultValue] -> ShowS

NFData DefaultValue

Defined in Data.API.Types

Methods

rnf :: DefaultValue -> ()

Eq DefaultValue

Defined in Data.API.Types

Methods

(==) :: DefaultValue -> DefaultValue -> Bool

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

Lift DefaultValue

Defined in Data.API.Types

Methods

lift :: Quote m => DefaultValue -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => DefaultValue -> Code m DefaultValue

data BasicType

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

FromJSON BasicType

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser BasicType

parseJSONList :: Value -> Parser [BasicType]

ToJSON BasicType

Defined in Data.API.Types

Methods

toJSON :: BasicType -> Value

toEncoding :: BasicType -> Encoding

toJSONList :: [BasicType] -> Value

toEncodingList :: [BasicType] -> Encoding

PP BasicType

Defined in Data.API.PP

Methods

pp :: BasicType -> String

Show BasicType

Defined in Data.API.Types

Methods

showsPrec :: Int -> BasicType -> ShowS

show :: BasicType -> String

showList :: [BasicType] -> ShowS

NFData BasicType

Defined in Data.API.Types

Methods

rnf :: BasicType -> ()

Eq BasicType

Defined in Data.API.Types

Methods

(==) :: BasicType -> BasicType -> Bool

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

Lift BasicType

Defined in Data.API.Types

Methods

lift :: Quote m => BasicType -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => BasicType -> Code m BasicType

data Filter

Constructors

FtrStrg RegEx

FtrIntg IntRange

FtrUTC UTCRange

Instances

FromJSON Filter

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser Filter

parseJSONList :: Value -> Parser [Filter]

ToJSON Filter

Defined in Data.API.Types

Methods

toJSON :: Filter -> Value

toEncoding :: Filter -> Encoding

toJSONList :: [Filter] -> Value

toEncodingList :: [Filter] -> Encoding

Show Filter

Defined in Data.API.Types

Methods

showsPrec :: Int -> Filter -> ShowS

show :: Filter -> String

showList :: [Filter] -> ShowS

NFData Filter

Defined in Data.API.Types

Methods

rnf :: Filter -> ()

Eq Filter

Defined in Data.API.Types

Methods

(==) :: Filter -> Filter -> Bool

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

Lift Filter

Defined in Data.API.Types

Methods

lift :: Quote m => Filter -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Filter -> Code m Filter

data IntRange

Constructors

IntRange

Fields

• ir_lo :: Maybe Int
• ir_hi :: Maybe Int

Instances

FromJSON IntRange

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser IntRange

parseJSONList :: Value -> Parser [IntRange]

ToJSON IntRange

Defined in Data.API.Types

Methods

toJSON :: IntRange -> Value

toEncoding :: IntRange -> Encoding

toJSONList :: [IntRange] -> Value

toEncodingList :: [IntRange] -> Encoding

Show IntRange

Defined in Data.API.Types

Methods

showsPrec :: Int -> IntRange -> ShowS

show :: IntRange -> String

showList :: [IntRange] -> ShowS

NFData IntRange

Defined in Data.API.Types

Methods

rnf :: IntRange -> ()

Eq IntRange

Defined in Data.API.Types

Methods

(==) :: IntRange -> IntRange -> Bool

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

Lift IntRange

Defined in Data.API.Types

Methods

lift :: Quote m => IntRange -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => IntRange -> Code m IntRange

data UTCRange

Constructors

UTCRange

Fields

• ur_lo :: Maybe UTCTime
• ur_hi :: Maybe UTCTime

Instances

FromJSON UTCRange

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser UTCRange

parseJSONList :: Value -> Parser [UTCRange]

ToJSON UTCRange

Defined in Data.API.Types

Methods

toJSON :: UTCRange -> Value

toEncoding :: UTCRange -> Encoding

toJSONList :: [UTCRange] -> Value

toEncodingList :: [UTCRange] -> Encoding

Show UTCRange

Defined in Data.API.Types

Methods

showsPrec :: Int -> UTCRange -> ShowS

show :: UTCRange -> String

showList :: [UTCRange] -> ShowS

NFData UTCRange

Defined in Data.API.Types

Methods

rnf :: UTCRange -> ()

Eq UTCRange

Defined in Data.API.Types

Methods

(==) :: UTCRange -> UTCRange -> Bool

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

Lift UTCRange

Defined in Data.API.Types

Methods

lift :: Quote m => UTCRange -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => UTCRange -> Code m UTCRange

data RegEx

Constructors

RegEx

Fields

• re_text :: Text
• re_regex :: Regex

Instances

FromJSON RegEx

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser RegEx

parseJSONList :: Value -> Parser [RegEx]

ToJSON RegEx

Defined in Data.API.Types

Methods

toJSON :: RegEx -> Value

toEncoding :: RegEx -> Encoding

toJSONList :: [RegEx] -> Value

toEncodingList :: [RegEx] -> Encoding

Show RegEx

Defined in Data.API.Types

Methods

showsPrec :: Int -> RegEx -> ShowS

show :: RegEx -> String

showList :: [RegEx] -> ShowS

NFData RegEx

Defined in Data.API.Types

Methods

rnf :: RegEx -> ()

Eq RegEx

Defined in Data.API.Types

Methods

(==) :: RegEx -> RegEx -> Bool

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

Lift RegEx

Defined in Data.API.Types

Methods

lift :: Quote m => RegEx -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => RegEx -> Code m RegEx

newtype Binary

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

Constructors

Binary

Fields

• _Binary :: ByteString

Instances

Arbitrary Binary

Defined in Data.API.Types

Methods

arbitrary :: Gen Binary

shrink :: Binary -> [Binary]

FromJSON Binary

Defined in Data.API.Types

Methods

parseJSON :: Value -> Parser Binary

parseJSONList :: Value -> Parser [Binary]

ToJSON Binary

Defined in Data.API.Types

Methods

toJSON :: Binary -> Value

toEncoding :: Binary -> Encoding

toJSONList :: [Binary] -> Value

toEncodingList :: [Binary] -> Encoding

FromJSONWithErrs Binary

Defined in Data.API.JSON

Methods

parseJSONWithErrs :: Value -> ParserWithErrs Binary

Example Binary

Defined in Data.API.Tools.Example

Methods

example :: Gen Binary

Show Binary

Defined in Data.API.Types

Methods

showsPrec :: Int -> Binary -> ShowS

show :: Binary -> String

showList :: [Binary] -> ShowS

NFData Binary

Defined in Data.API.Types

Methods

rnf :: Binary -> ()

Eq Binary

Defined in Data.API.Types

Methods

(==) :: Binary -> Binary -> Bool

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

Ord Binary

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

SafeCopy Binary

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

Defined in Data.API.Types

Methods

encode :: Binary -> Encoding

decode :: Decoder s Binary

encodeList :: [Binary] -> Encoding

decodeList :: Decoder s [Binary]

defaultValueAsJsValue :: DefaultValue -> Value

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

inIntRange :: Int -> IntRange -> Bool

inUTCRange :: UTCTime -> UTCRange -> Bool

base64ToBinary :: Text -> Either String Binary

Orphan instances

Arbitrary Text

Methods

arbitrary :: Gen Text

shrink :: Text -> [Text]

FromJSON s => FromJSON (CI s)

Methods

parseJSON :: Value -> Parser (CI s)

parseJSONList :: Value -> Parser [CI s]

ToJSON s => ToJSON (CI s)

Methods

toJSON :: CI s -> Value

toEncoding :: CI s -> Encoding

toJSONList :: [CI s] -> Value

toEncodingList :: [CI s] -> Encoding