Test.KeyedVals.Types

This module provides types that demonstrate how to use KeyVals.Handle.Typed

The declared types are used in hspec tests used to validate implementations of Handle

data types

newtype VarDemo

A simple type to illustrate storing key-values at varying storage paths.

it's just a simple type (Either) wrapped in newtype to avoid orphan instances.

Constructors

VarDemo (Either Text Bool)

Instances

FromJSON VarDemo

Defined in Test.KeyedVals.Types

Methods

parseJSON :: Value -> Parser VarDemo

parseJSONList :: Value -> Parser [VarDemo]

ToJSON VarDemo

Defined in Test.KeyedVals.Types

Methods

toJSON :: VarDemo -> Value

toEncoding :: VarDemo -> Encoding

toJSONList :: [VarDemo] -> Value

toEncodingList :: [VarDemo] -> Encoding

Show VarDemo

Defined in Test.KeyedVals.Types

Methods

showsPrec :: Int -> VarDemo -> ShowS

show :: VarDemo -> String

showList :: [VarDemo] -> ShowS

Eq VarDemo

Defined in Test.KeyedVals.Types

Methods

(==) :: VarDemo -> VarDemo -> Bool

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

DecodeKV VarDemo

Defined in Test.KeyedVals.Types

Methods

decodeKV :: Val -> Either Text VarDemo

EncodeKV VarDemo

Defined in Test.KeyedVals.Types

Methods

encodeKV :: VarDemo -> Val

PathOf VarDemo

Describe how VarDemos are stored in the key-value store

Defined in Test.KeyedVals.Types

Associated Types

type KVPath VarDemo :: Symbol

type KeyType VarDemo

VaryingPathOf VarDemo

Specify how to derive the path to store VarDemos in the key-value store

This instance uses expand to replace the {} in the KVPath with the variable portion of the key.

Defined in Test.KeyedVals.Types

Associated Types

type PathVar VarDemo

Methods

modifyPath :: Proxy VarDemo -> PathVar VarDemo -> Key -> Key

type KVPath VarDemo

Defined in Test.KeyedVals.Types

type KVPath VarDemo = "/testing/{}/var"

type KeyType VarDemo

Defined in Test.KeyedVals.Types

type KeyType VarDemo = VarDemoKey

type PathVar VarDemo

Defined in Test.KeyedVals.Types

type PathVar VarDemo = VarDemoID

data VarDemoKey

The keys for each VarDemo are Ints.

Instances

Num VarDemoKey

Defined in Test.KeyedVals.Types

Methods

(+) :: VarDemoKey -> VarDemoKey -> VarDemoKey

(-) :: VarDemoKey -> VarDemoKey -> VarDemoKey

(*) :: VarDemoKey -> VarDemoKey -> VarDemoKey

negate :: VarDemoKey -> VarDemoKey

abs :: VarDemoKey -> VarDemoKey

signum :: VarDemoKey -> VarDemoKey

fromInteger :: Integer -> VarDemoKey

Show VarDemoKey

Defined in Test.KeyedVals.Types

Methods

showsPrec :: Int -> VarDemoKey -> ShowS

show :: VarDemoKey -> String

showList :: [VarDemoKey] -> ShowS

Eq VarDemoKey

Defined in Test.KeyedVals.Types

Methods

(==) :: VarDemoKey -> VarDemoKey -> Bool

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

Ord VarDemoKey

Defined in Test.KeyedVals.Types

Methods

compare :: VarDemoKey -> VarDemoKey -> Ordering

(<) :: VarDemoKey -> VarDemoKey -> Bool

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

(>) :: VarDemoKey -> VarDemoKey -> Bool

(>=) :: VarDemoKey -> VarDemoKey -> Bool

max :: VarDemoKey -> VarDemoKey -> VarDemoKey

min :: VarDemoKey -> VarDemoKey -> VarDemoKey

FromHttpApiData VarDemoKey

Defined in Test.KeyedVals.Types

Methods

parseUrlPiece :: Text -> Either Text VarDemoKey

parseHeader :: ByteString -> Either Text VarDemoKey

parseQueryParam :: Text -> Either Text VarDemoKey

ToHttpApiData VarDemoKey

Defined in Test.KeyedVals.Types

Methods

toUrlPiece :: VarDemoKey -> Text

toEncodedUrlPiece :: VarDemoKey -> Builder

toHeader :: VarDemoKey -> ByteString

toQueryParam :: VarDemoKey -> Text

DecodeKV VarDemoKey

Defined in Test.KeyedVals.Types

Methods

decodeKV :: Val -> Either Text VarDemoKey

EncodeKV VarDemoKey

Defined in Test.KeyedVals.Types

Methods

encodeKV :: VarDemoKey -> Val

data VarDemoID

Groups of VarDemo are stored for different VarDemoID.

Instances

IsString VarDemoID

Defined in Test.KeyedVals.Types

Methods

fromString :: String -> VarDemoID

Show VarDemoID

Defined in Test.KeyedVals.Types

Methods

showsPrec :: Int -> VarDemoID -> ShowS

show :: VarDemoID -> String

showList :: [VarDemoID] -> ShowS

Eq VarDemoID

Defined in Test.KeyedVals.Types

Methods

(==) :: VarDemoID -> VarDemoID -> Bool

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

FromHttpApiData VarDemoID

Defined in Test.KeyedVals.Types

Methods

parseUrlPiece :: Text -> Either Text VarDemoID

parseHeader :: ByteString -> Either Text VarDemoID

parseQueryParam :: Text -> Either Text VarDemoID

ToHttpApiData VarDemoID

Defined in Test.KeyedVals.Types

Methods

toUrlPiece :: VarDemoID -> Text

toEncodedUrlPiece :: VarDemoID -> Builder

toHeader :: VarDemoID -> ByteString

toQueryParam :: VarDemoID -> Text

DecodeKV VarDemoID

Defined in Test.KeyedVals.Types

Methods

decodeKV :: Val -> Either Text VarDemoID

EncodeKV VarDemoID

Defined in Test.KeyedVals.Types

Methods

encodeKV :: VarDemoID -> Val

newtype FixedDemo

A simple type to illustrate storing key-values at a fixed storage path

it's just a simple type (tuple) wrapped in newtype to avoid orphan instances.

Constructors

FixedDemo (Int, Text)

Instances

FromJSON FixedDemo

Defined in Test.KeyedVals.Types

Methods

parseJSON :: Value -> Parser FixedDemo

parseJSONList :: Value -> Parser [FixedDemo]

ToJSON FixedDemo

Defined in Test.KeyedVals.Types

Methods

toJSON :: FixedDemo -> Value

toEncoding :: FixedDemo -> Encoding

toJSONList :: [FixedDemo] -> Value

toEncodingList :: [FixedDemo] -> Encoding

Show FixedDemo

Defined in Test.KeyedVals.Types

Methods

showsPrec :: Int -> FixedDemo -> ShowS

show :: FixedDemo -> String

showList :: [FixedDemo] -> ShowS

Eq FixedDemo

Defined in Test.KeyedVals.Types

Methods

(==) :: FixedDemo -> FixedDemo -> Bool

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

DecodeKV FixedDemo

Defined in Test.KeyedVals.Types

Methods

decodeKV :: Val -> Either Text FixedDemo

EncodeKV FixedDemo

Defined in Test.KeyedVals.Types

Methods

encodeKV :: FixedDemo -> Val

PathOf FixedDemo

Specify how FixedDemos are stored in the key-value store

Defined in Test.KeyedVals.Types

Associated Types

type KVPath FixedDemo :: Symbol

type KeyType FixedDemo

type KVPath FixedDemo

Defined in Test.KeyedVals.Types

type KVPath FixedDemo = "/testing/fixed"

type KeyType FixedDemo

Defined in Test.KeyedVals.Types

type KeyType FixedDemo = FixedDemoKey

data FixedDemoKey

The keys for each FixedDemo are Ints.

Instances

Num FixedDemoKey

Defined in Test.KeyedVals.Types

Methods

(+) :: FixedDemoKey -> FixedDemoKey -> FixedDemoKey

(-) :: FixedDemoKey -> FixedDemoKey -> FixedDemoKey

(*) :: FixedDemoKey -> FixedDemoKey -> FixedDemoKey

negate :: FixedDemoKey -> FixedDemoKey

abs :: FixedDemoKey -> FixedDemoKey

signum :: FixedDemoKey -> FixedDemoKey

fromInteger :: Integer -> FixedDemoKey

Show FixedDemoKey

Defined in Test.KeyedVals.Types

Methods

showsPrec :: Int -> FixedDemoKey -> ShowS

show :: FixedDemoKey -> String

showList :: [FixedDemoKey] -> ShowS

Eq FixedDemoKey

Defined in Test.KeyedVals.Types

Methods

(==) :: FixedDemoKey -> FixedDemoKey -> Bool

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

Ord FixedDemoKey

Defined in Test.KeyedVals.Types

Methods

compare :: FixedDemoKey -> FixedDemoKey -> Ordering

(<) :: FixedDemoKey -> FixedDemoKey -> Bool

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

(>) :: FixedDemoKey -> FixedDemoKey -> Bool

(>=) :: FixedDemoKey -> FixedDemoKey -> Bool

max :: FixedDemoKey -> FixedDemoKey -> FixedDemoKey

min :: FixedDemoKey -> FixedDemoKey -> FixedDemoKey

FromHttpApiData FixedDemoKey

Defined in Test.KeyedVals.Types

Methods

parseUrlPiece :: Text -> Either Text FixedDemoKey

parseHeader :: ByteString -> Either Text FixedDemoKey

parseQueryParam :: Text -> Either Text FixedDemoKey

ToHttpApiData FixedDemoKey

Defined in Test.KeyedVals.Types

Methods

toUrlPiece :: FixedDemoKey -> Text

toEncodedUrlPiece :: FixedDemoKey -> Builder

toHeader :: FixedDemoKey -> ByteString

toQueryParam :: FixedDemoKey -> Text

DecodeKV FixedDemoKey

Defined in Test.KeyedVals.Types

Methods

decodeKV :: Val -> Either Text FixedDemoKey

EncodeKV FixedDemoKey

Defined in Test.KeyedVals.Types

Methods

encodeKV :: FixedDemoKey -> Val