Safe Haskell	Safe-Inferred
Language	Haskell2010

Ribosome.Host.Class.Msgpack.Decode

Description

The class for decoding messagepack.

Synopsis

class MsgpackDecode a where
- fromMsgpack :: Object -> Either DecodeError a
class MissingKey a where
- missingKey :: String -> Map String Object -> Either FieldError a
pattern Msgpack :: forall a. MsgpackDecode a => a -> Object

Documentation

class MsgpackDecode a where Source #

Class of values that can be decoded from MessagePack Objects.

Minimal complete definition

Nothing

Methods

fromMsgpack :: Object -> Either DecodeError a Source #

Decode a value from a MessagePack Object.

The default implementation uses generic derivation.

default fromMsgpack :: Typeable a => ReifySOP a ass => GMsgpackDecode (GDatatypeInfoOf a) (GCode a) => Object -> Either DecodeError a Source #

Instances

Instances details

MsgpackDecode Int64 Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError Int64 Source #
MsgpackDecode ByteString Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError ByteString Source #
MsgpackDecode Object Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError Object Source #
MsgpackDecode MicroSeconds Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError MicroSeconds Source #
MsgpackDecode MilliSeconds Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError MilliSeconds Source #
MsgpackDecode NanoSeconds Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError NanoSeconds Source #
MsgpackDecode Seconds Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError Seconds Source #
MsgpackDecode Buffer Source #
Instance details Defined in Ribosome.Host.Api.Data Methods fromMsgpack :: Object -> Either DecodeError Buffer Source #
MsgpackDecode Tabpage Source #
Instance details Defined in Ribosome.Host.Api.Data Methods fromMsgpack :: Object -> Either DecodeError Tabpage Source #
MsgpackDecode Window Source #
Instance details Defined in Ribosome.Host.Api.Data Methods fromMsgpack :: Object -> Either DecodeError Window Source #
MsgpackDecode DecodeError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError DecodeError Source #
MsgpackDecode FieldError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError FieldError Source #
MsgpackDecode ValidUtf8 Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError ValidUtf8 Source #
MsgpackDecode ValidUtf8String Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError ValidUtf8String Source #
MsgpackDecode ApiInfo Source #
Instance details Defined in Ribosome.Host.Data.ApiInfo Methods fromMsgpack :: Object -> Either DecodeError ApiInfo Source #
MsgpackDecode ExtType Source #
Instance details Defined in Ribosome.Host.Data.ApiInfo Methods fromMsgpack :: Object -> Either DecodeError ExtType Source #
MsgpackDecode ExtTypeMeta Source #
Instance details Defined in Ribosome.Host.Data.ApiInfo Methods fromMsgpack :: Object -> Either DecodeError ExtTypeMeta Source #
MsgpackDecode RpcDecl Source #
Instance details Defined in Ribosome.Host.Data.ApiInfo Methods fromMsgpack :: Object -> Either DecodeError RpcDecl Source #
MsgpackDecode ApiType Source #
Instance details Defined in Ribosome.Host.Data.ApiType Methods fromMsgpack :: Object -> Either DecodeError ApiType Source #
MsgpackDecode Bang Source #
Instance details Defined in Ribosome.Host.Data.Bang Methods fromMsgpack :: Object -> Either DecodeError Bang Source #
MsgpackDecode Bar Source #
Instance details Defined in Ribosome.Host.Data.Bar Methods fromMsgpack :: Object -> Either DecodeError Bar Source #
MsgpackDecode ChannelId Source #
Instance details Defined in Ribosome.Host.Data.ChannelId Methods fromMsgpack :: Object -> Either DecodeError ChannelId Source #
MsgpackDecode CommandMods Source #
Instance details Defined in Ribosome.Host.Data.CommandMods Methods fromMsgpack :: Object -> Either DecodeError CommandMods Source #
MsgpackDecode CommandRegister Source #
Instance details Defined in Ribosome.Host.Data.CommandRegister Methods fromMsgpack :: Object -> Either DecodeError CommandRegister Source #
MsgpackDecode EventName Source #
Instance details Defined in Ribosome.Host.Data.Event Methods fromMsgpack :: Object -> Either DecodeError EventName Source #
MsgpackDecode Execution Source #
Instance details Defined in Ribosome.Host.Data.Execution Methods fromMsgpack :: Object -> Either DecodeError Execution Source #
MsgpackDecode LuaRef Source #
Instance details Defined in Ribosome.Host.Data.LuaRef Methods fromMsgpack :: Object -> Either DecodeError LuaRef Source #
MsgpackDecode RequestId Source #
Instance details Defined in Ribosome.Host.Data.Request Methods fromMsgpack :: Object -> Either DecodeError RequestId Source #
MsgpackDecode RpcMethod Source #
Instance details Defined in Ribosome.Host.Data.Request Methods fromMsgpack :: Object -> Either DecodeError RpcMethod Source #
MsgpackDecode RpcError Source #
Instance details Defined in Ribosome.Host.Data.RpcError Methods fromMsgpack :: Object -> Either DecodeError RpcError Source #
MsgpackDecode RpcMessage Source #
Instance details Defined in Ribosome.Host.Data.RpcMessage Methods fromMsgpack :: Object -> Either DecodeError RpcMessage Source #
MsgpackDecode AutocmdBuffer Source #
Instance details Defined in Ribosome.Host.Data.RpcType Methods fromMsgpack :: Object -> Either DecodeError AutocmdBuffer Source #
MsgpackDecode AutocmdEvents Source #
Instance details Defined in Ribosome.Host.Data.RpcType Methods fromMsgpack :: Object -> Either DecodeError AutocmdEvents Source #
MsgpackDecode AutocmdGroup Source #
Instance details Defined in Ribosome.Host.Data.RpcType Methods fromMsgpack :: Object -> Either DecodeError AutocmdGroup Source #
MsgpackDecode AutocmdId Source #
Instance details Defined in Ribosome.Host.Data.RpcType Methods fromMsgpack :: Object -> Either DecodeError AutocmdId Source #
MsgpackDecode AutocmdPatterns Source #
Instance details Defined in Ribosome.Host.Data.RpcType Methods fromMsgpack :: Object -> Either DecodeError AutocmdPatterns Source #
MsgpackDecode Text Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError Text Source #
MsgpackDecode String Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError String Source #
MsgpackDecode Integer Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError Integer Source #
MsgpackDecode () Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError () Source #
MsgpackDecode Bool Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError Bool Source #
MsgpackDecode Char Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError Char Source #
MsgpackDecode Double Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError Double Source #
MsgpackDecode Float Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError Float Source #
MsgpackDecode Int Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError Int Source #
Typeable style => MsgpackDecode (Range style) Source #
Instance details Defined in Ribosome.Host.Data.Range Methods fromMsgpack :: Object -> Either DecodeError (Range style) Source #
MsgpackDecode a => MsgpackDecode (Maybe a) Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError (Maybe a) Source #
(Typeable a, MsgpackDecode a) => MsgpackDecode [a] Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError [a] Source #
(MsgpackDecode a, MsgpackDecode b) => MsgpackDecode (Either a b) Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError (Either a b) Source #
(Ord k, Typeable k, Typeable v, MsgpackDecode k, MsgpackDecode v) => MsgpackDecode (Map k v) Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError (Map k v) Source #
(Typeable b, Typeable t, DecodePath b t) => MsgpackDecode (Path b t) Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError (Path b t) Source #
(Typeable a, Typeable b, MsgpackDecode a, MsgpackDecode b) => MsgpackDecode (a, b) Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError (a, b) Source #
(Typeable a, Typeable b, Typeable c, MsgpackDecode a, MsgpackDecode b, MsgpackDecode c) => MsgpackDecode (a, b, c) Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError (a, b, c) Source #
(Typeable a, Typeable b, Typeable c, Typeable d, MsgpackDecode a, MsgpackDecode b, MsgpackDecode c, MsgpackDecode d) => MsgpackDecode (a, b, c, d) Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError (a, b, c, d) Source #
(Typeable a, Typeable b, Typeable c, Typeable d, Typeable e, MsgpackDecode a, MsgpackDecode b, MsgpackDecode c, MsgpackDecode d, MsgpackDecode e) => MsgpackDecode (a, b, c, d, e) Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError (a, b, c, d, e) Source #
(Typeable a, Typeable b, Typeable c, Typeable d, Typeable e, Typeable f, MsgpackDecode a, MsgpackDecode b, MsgpackDecode c, MsgpackDecode d, MsgpackDecode e, MsgpackDecode f) => MsgpackDecode (a, b, c, d, e, f) Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError (a, b, c, d, e, f) Source #
(Typeable a, Typeable b, Typeable c, Typeable d, Typeable e, Typeable f, Typeable g, MsgpackDecode a, MsgpackDecode b, MsgpackDecode c, MsgpackDecode d, MsgpackDecode e, MsgpackDecode f, MsgpackDecode g) => MsgpackDecode (a, b, c, d, e, f, g) Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError (a, b, c, d, e, f, g) Source #

class MissingKey a where Source #

This class decides what to return when a key in an ObjectMap is missing for a corresponding record field.

Primarily used for Maybe fields, since they should decode to Nothing when the key is absent.

Methods

missingKey :: String -> Map String Object -> Either FieldError a Source #

Return a fallback value for a missing key in an ObjectMap.

Instances

Instances details

MissingKey a Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods missingKey :: String -> Map String Object -> Either FieldError a Source #
MissingKey (Maybe a) Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods missingKey :: String -> Map String Object -> Either FieldError (Maybe a) Source #

pattern Msgpack :: forall a. MsgpackDecode a => a -> Object Source #

Pattern synonym for decoding an Object.