Haxl.Core.Flags

The Flags type and related functions. This module is provided for access to Haxl internals only; most users should import Haxl.Core instead.

Report flags

data ReportFlag

Constructors

ReportOutgoneFetches

outgone fetches, for debugging eg: timeouts

ReportFetchStats

data fetch stats & errors

ReportProfiling

enabling label stack and profiling

ReportExceptionLabelStack

include label stack in HaxlException

ReportFetchStack

log cost-center stack traces of dataFetch calls

Instances

Bounded ReportFlag

Defined in Haxl.Core.Flags

Methods

minBound :: ReportFlag

maxBound :: ReportFlag

Enum ReportFlag

Defined in Haxl.Core.Flags

Methods

succ :: ReportFlag -> ReportFlag

pred :: ReportFlag -> ReportFlag

toEnum :: Int -> ReportFlag

fromEnum :: ReportFlag -> Int

enumFrom :: ReportFlag -> [ReportFlag]

enumFromThen :: ReportFlag -> ReportFlag -> [ReportFlag]

enumFromTo :: ReportFlag -> ReportFlag -> [ReportFlag]

enumFromThenTo :: ReportFlag -> ReportFlag -> ReportFlag -> [ReportFlag]

Eq ReportFlag

Defined in Haxl.Core.Flags

Methods

(==) :: ReportFlag -> ReportFlag -> Bool

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

Show ReportFlag

Defined in Haxl.Core.Flags

Methods

showsPrec :: Int -> ReportFlag -> ShowS

show :: ReportFlag -> String

showList :: [ReportFlag] -> ShowS

data ReportFlags

Instances

Show ReportFlags

Defined in Haxl.Core.Flags

Methods

showsPrec :: Int -> ReportFlags -> ShowS

show :: ReportFlags -> String

showList :: [ReportFlags] -> ShowS

defaultReportFlags :: ReportFlags

profilingReportFlags :: ReportFlags

setReportFlag :: ReportFlag -> ReportFlags -> ReportFlags

clearReportFlag :: ReportFlag -> ReportFlags -> ReportFlags

testReportFlag :: ReportFlag -> ReportFlags -> Bool

Flags

data Flags

Flags that control the operation of the engine.

Constructors

Flags

Fields

• trace :: !Int

  Tracing level (0 = quiet, 3 = very verbose).

• report :: !ReportFlags

  Report flags

• caching :: !Int

  Non-zero if caching is enabled. If caching is disabled, then we still do batching and de-duplication, but do not cache results.

• recording :: !Int

  Non-zero if recording is enabled. This allows tests to record cache calls for datasources by making uncachedRequest behave like dataFetch

defaultFlags :: Flags

ifTrace :: Monad m => Flags -> Int -> m a -> m ()

Runs an action if the tracing level is above the given threshold.

ifReport :: Monad m => Flags -> ReportFlag -> m a -> m ()

Runs an action if the ReportFlag is set.

ifProfiling :: Monad m => Flags -> m a -> m ()