Polysemy.Http.Effect.Entity

Documentation

data EntityError

Generic error type for decoders.

Constructors

EntityError

Fields

• body :: Text
• message :: Text

Instances

Eq EntityError

Defined in Polysemy.Http.Effect.Entity

Methods

(==) :: EntityError -> EntityError -> Bool

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

Show EntityError

Defined in Polysemy.Http.Effect.Entity

Methods

showsPrec :: Int -> EntityError -> ShowS

show :: EntityError -> String

showList :: [EntityError] -> ShowS

data EntityEncode d :: Effect where

Abstraction of json encoding, potentially usable for other content types like xml.

Constructors

Encode :: d -> EntityEncode d m LByteString

EncodeStrict :: d -> EntityEncode d m ByteString

Instances

type DefiningModule EntityEncode

Defined in Polysemy.Http.Effect.Entity

type DefiningModule EntityEncode = "Polysemy.Http.Effect.Entity"

encode :: forall d r. Member (EntityEncode d) r => d -> Sem r LByteString

Lazily encode a value of type d to a LByteString

encodeStrict :: forall d r. Member (EntityEncode d) r => d -> Sem r ByteString

Strictly encode a value of type d to a ByteString

data EntityDecode d :: Effect where

Abstraction of json decoding, potentially usable for other content types like xml.

Constructors

Decode :: LByteString -> EntityDecode d m (Either EntityError d)

DecodeStrict :: ByteString -> EntityDecode d m (Either EntityError d)

Instances

type DefiningModule EntityDecode

Defined in Polysemy.Http.Effect.Entity

type DefiningModule EntityDecode = "Polysemy.Http.Effect.Entity"

decode :: forall d r. Member (EntityDecode d) r => LByteString -> Sem r (Either EntityError d)

Lazily decode a LByteString to a value of type d

decodeStrict :: forall d r. Member (EntityDecode d) r => ByteString -> Sem r (Either EntityError d)

Strictly decode a ByteString to a value of type d

data Encode a

Marker type to be used with Entities

data Decode a

Marker type to be used with Entities

type family Entities es r :: Constraint where ...

Convenience constraint for requiring multiple entity effects, to be used like Members.

foo :: Entities [Encode Int, Decode Double] r => Sem r ()

Equations

Entities '[] r = ()

Entities (Encode d ': ds) r = (Member (EntityEncode d) r, Entities ds r)

Entities (Decode d ': ds) r = (Member (EntityDecode d) r, Entities ds r)

type family Encoders es r :: Constraint where ...

Convenience constraint for requiring multiple encoders.

foo :: Encoders [Int, Double] r => Sem r ()

Equations

Encoders '[] r = ()

Encoders (d ': ds) r = (Member (EntityEncode d) r, Encoders ds r)

type family Decoders ds r :: Constraint where ...

Convenience constraint for requiring multiple decoders.

foo :: Decoders [Int, Double] r => Sem r ()

Equations

Decoders '[] r = ()

Decoders (d ': ds) r = (Member (EntityDecode d) r, Decoders ds r)