Safe Haskell	Safe-Inferred
Language	Haskell2010

Ribosome.Host.Class.Msgpack.Error

Description

Errors for messagepack decoding.

Synopsis

data FieldError
- = FieldError Text
- | NestedFieldError DecodeError
data DecodeError = DecodeError {
- mainType :: Text
- fieldError :: FieldError
}
renderError :: DecodeError -> Text
toDecodeError :: forall a. Typeable a => Either FieldError a -> Either DecodeError a
decodeError :: forall a. Typeable a => Text -> Either DecodeError a
incompatible :: forall a. Typeable a => Object -> Either FieldError a
decodeIncompatible :: forall a. Typeable a => Object -> Either DecodeError a

Documentation

data FieldError Source #

A decoding error in a field of a larger type.

May be nested arbitrarily deep.

Constructors

FieldError Text
NestedFieldError DecodeError

Instances

Instances details

IsString FieldError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Error Methods fromString :: String -> FieldError #
Generic FieldError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Error Associated Types type Rep FieldError :: Type -> Type # Methods from :: FieldError -> Rep FieldError x # to :: Rep FieldError x -> FieldError #
Show FieldError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Error Methods showsPrec :: Int -> FieldError -> ShowS # show :: FieldError -> String # showList :: [FieldError] -> ShowS #
Eq FieldError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Error Methods (==) :: FieldError -> FieldError -> Bool # (/=) :: FieldError -> FieldError -> Bool #
MsgpackDecode FieldError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError FieldError Source #
MsgpackEncode FieldError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Encode Methods toMsgpack :: FieldError -> Object Source #
type Rep FieldError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Error type Rep FieldError = D1 ('MetaData "FieldError" "Ribosome.Host.Class.Msgpack.Error" "ribosome-host-0.9.9.9-4n86eC1033RAA2pmC2T1m9" 'False) (C1 ('MetaCons "FieldError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "NestedFieldError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DecodeError)))

data DecodeError Source #

A messagepack decoding error.

Constructors

DecodeError
Fields mainType :: Text The name of the type being decoded. fieldError :: FieldError An error, potentially nested in other types.

Instances

Instances details

Generic DecodeError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Error Associated Types type Rep DecodeError :: Type -> Type # Methods from :: DecodeError -> Rep DecodeError x # to :: Rep DecodeError x -> DecodeError #
Show DecodeError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Error Methods showsPrec :: Int -> DecodeError -> ShowS # show :: DecodeError -> String # showList :: [DecodeError] -> ShowS #
Eq DecodeError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Error Methods (==) :: DecodeError -> DecodeError -> Bool # (/=) :: DecodeError -> DecodeError -> Bool #
MsgpackDecode DecodeError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Decode Methods fromMsgpack :: Object -> Either DecodeError DecodeError Source #
MsgpackEncode DecodeError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Encode Methods toMsgpack :: DecodeError -> Object Source #
Reportable DecodeError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Error Methods toReport :: DecodeError -> Report Source #
type Rep DecodeError Source #
Instance details Defined in Ribosome.Host.Class.Msgpack.Error type Rep DecodeError = D1 ('MetaData "DecodeError" "Ribosome.Host.Class.Msgpack.Error" "ribosome-host-0.9.9.9-4n86eC1033RAA2pmC2T1m9" 'False) (C1 ('MetaCons "DecodeError" 'PrefixI 'True) (S1 ('MetaSel ('Just "mainType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "fieldError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FieldError)))

renderError :: DecodeError -> Text Source #

Create a user-friendly message for a DecodeError.

toDecodeError :: forall a. Typeable a => Either FieldError a -> Either DecodeError a Source #

Convert a FieldError in a Left to a DecodeError by adding the type name via Typeable.

decodeError :: forall a. Typeable a => Text -> Either DecodeError a Source #

Create a Left DecodeError from a Text by adding the type name via Typeable.

incompatible :: forall a. Typeable a => Object -> Either FieldError a Source #

Create a FieldError for a field when the Object constructor is wrong, using Typeable to obtain the type name.

decodeIncompatible :: forall a. Typeable a => Object -> Either DecodeError a Source #

Create a DecodeError for a type when the Object constructor is wrong, using Typeable to obtain the type name.