Language.GraphQL.Error

Error handling.

Documentation

type CollectErrsT m = StateT (Resolution m) m

A wrapper to pass error messages around.

/CollectErrsT was part of the old executor and isn't used anymore, it will be deprecated in the future and removed./

data Error

GraphQL error.

Constructors

Error

Fields

• message :: Text
• locations :: [Location]
• path :: [Path]

Instances

Eq Error

Defined in Language.GraphQL.Error

Methods

(==) :: Error -> Error -> Bool

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

Show Error

Defined in Language.GraphQL.Error

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

data Path

If an error can be associated to a particular field in the GraphQL result, it must contain an entry with the key path that details the path of the response field which experienced the error. This allows clients to identify whether a null result is intentional or caused by a runtime error.

Constructors

Segment Text

Field name.

Index Int

List index if a field returned a list.

Instances

Eq Path

Defined in Language.GraphQL.Error

Methods

(==) :: Path -> Path -> Bool

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

Show Path

Defined in Language.GraphQL.Error

Methods

showsPrec :: Int -> Path -> ShowS

show :: Path -> String

showList :: [Path] -> ShowS

data Resolution m

Executor context.

/Resolution was part of the old executor and isn't used anymore, it will be deprecated in the future and removed./

Constructors

Resolution

Fields

• errors :: Seq Error
• types :: HashMap Name (Type m)

data ResolverException

Only exceptions that inherit from ResolverException a cought by the executor.

Constructors

forall e.Exception e => ResolverException e

Instances

Show ResolverException

Defined in Language.GraphQL.Error

Methods

showsPrec :: Int -> ResolverException -> ShowS

show :: ResolverException -> String

showList :: [ResolverException] -> ShowS

Exception ResolverException

Defined in Language.GraphQL.Error

Methods

toException :: ResolverException -> SomeException

fromException :: SomeException -> Maybe ResolverException

displayException :: ResolverException -> String

data Response a

The server's response describes the result of executing the requested operation if successful, and describes any errors encountered during the request.

Constructors

Response

Fields

• data' :: a
• errors :: Seq Error

Instances

Eq a => Eq (Response a)

Defined in Language.GraphQL.Error

Methods

(==) :: Response a -> Response a -> Bool

(/=) :: Response a -> Response a -> Bool

Show a => Show (Response a)

Defined in Language.GraphQL.Error

Methods

showsPrec :: Int -> Response a -> ShowS

show :: Response a -> String

showList :: [Response a] -> ShowS

type ResponseEventStream m a = ConduitT () (Response a) m ()

Each event in the underlying Source Stream triggers execution of the subscription selection set. The results of the execution generate a Response Stream.

addErr :: Monad m => Error -> CollectErrsT m ()

Adds an error to the list of errors.

addErrMsg :: (Monad m, Serialize a) => Text -> CollectErrsT m a

Convenience function for just wrapping an error message.

parseError :: (Applicative f, Serialize a) => ParseErrorBundle Text Void -> f (Response a)

Wraps a parse error into a list of errors.

runCollectErrs :: (Monad m, Serialize a) => HashMap Name (Type m) -> CollectErrsT m a -> m (Response a)

Runs the given query computation, but collects the errors into an error list, which is then sent back with the data.

/runCollectErrs was part of the old executor and isn't used anymore, it will be deprecated in the future and removed./

singleError :: Serialize a => Text -> Response a

Constructs a response object containing only the error with the given message.