Safe Haskell	Safe-Inferred
Language	Haskell2010

Ribosome.Host.Class.Msgpack.Decode

Description

Decoding values from MessagePack format

Synopsis

class MsgpackDecode a where
- fromMsgpack :: Object -> Either Text a
- missingKey :: String -> Object -> Either Text 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 Text a Source #

Attempt to decode an Object, returning an error message in a Left if the data is incompatible.

The default implementation uses generic derivation.

default fromMsgpack :: (Generic a, GMsgpackDecode (Rep a)) => Object -> Either Text a Source #

missingKey :: String -> Object -> Either Text a Source #

Utility method called by the generic machinery when a record key is missing.

Instances

Instances details

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

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

Pattern synonym for decoding an Object.