Skip to content

HORIZON HASKELL Docs lts/ghc-10.0.x77a86622026-10-31Search packagesCtrl K

Theme: |

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 77a8662 · 2026-10-31

Modulecriterion-1.6.5.0Haskell2010

Criterion.Main.Options

Benchmarking command-line configuration.

Synopsis

data Mode
data MatchType
value defaultConfig
value parseWith
value config
value describe
value describeWith
value versionInfo

Packagecriterion-1.6.5.0
Exports8
LanguageHaskell2010
LicenceBSD-3-Clause
SourceOptions.hs

datadata Mode

Execution mode for a benchmark program.

Constructors

List
List all benchmarks.
Version
Print the version.
RunIters Config Int64 MatchType [String]
Run the given benchmarks, without collecting or analysing performance numbers.
Run Config MatchType [String]
Run and analyse the given benchmarks.

Instances6Eq, Data, Read, Show, Generic, Rep

Eq ModeDefined in criterion-1.6.5.0 · Criterion.Main.Options
Data ModeDefined in criterion-1.6.5.0 · Criterion.Main.Options
Read ModeDefined in criterion-1.6.5.0 · Criterion.Main.Options
Show ModeDefined in criterion-1.6.5.0 · Criterion.Main.Options
Generic ModeDefined in criterion-1.6.5.0 · Criterion.Main.Options
type Rep Mode = D1 ('MetaData "Mode" "Criterion.Main.Options" "criterion-1.6.5.0-59nFTlybyPvM53QZofuC2" 'False) ((C1 ('MetaCons "List" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Version" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "RunIters" 'PrefixI 'False) ((S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Config) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MatchType) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]))) :+: C1 ('MetaCons "Run" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Config) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MatchType) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String])))))Defined in criterion-1.6.5.0 · Criterion.Main.Options

datadata MatchType

How to match a benchmark name.

Constructors

Prefix
Match by prefix. For example, a prefix of "foo" will match "foobar".
Glob
Match by Unix-style glob pattern. When using this match type, benchmark names are treated as if they were file-paths. For example, the glob patterns "*/ba*" and "*/*" will match "foo/bar", but "*" or "*bar" will not.
Pattern
Match by searching given substring in benchmark paths.
IPattern
Same as Pattern, but case insensitive.

Instances9Bounded, Enum, Eq, Data, Ord, Read, …

Bounded MatchTypeDefined in criterion-1.6.5.0 · Criterion.Main.Options
Enum MatchTypeDefined in criterion-1.6.5.0 · Criterion.Main.Options
Eq MatchTypeDefined in criterion-1.6.5.0 · Criterion.Main.Options
Data MatchTypeDefined in criterion-1.6.5.0 · Criterion.Main.Options
Ord MatchTypeDefined in criterion-1.6.5.0 · Criterion.Main.Options
Read MatchTypeDefined in criterion-1.6.5.0 · Criterion.Main.Options
Show MatchTypeDefined in criterion-1.6.5.0 · Criterion.Main.Options
Generic MatchTypeDefined in criterion-1.6.5.0 · Criterion.Main.Options
type Rep MatchType = D1 ('MetaData "MatchType" "Criterion.Main.Options" "criterion-1.6.5.0-59nFTlybyPvM53QZofuC2" 'False) ((C1 ('MetaCons "Prefix" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Glob" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "Pattern" 'PrefixI 'False) U1 :+: C1 ('MetaCons "IPattern" 'PrefixI 'False) U1))Defined in criterion-1.6.5.0 · Criterion.Main.Options

valuedefaultConfig :: Config

Default benchmarking configuration.

valueparseWith

:: Config
Default configuration to use if options are not explicitly specified.
-> Parser Mode

Parse a command line.

valueconfig :: Config -> Parser Config

Parse a configuration.

valuedescribe :: Config -> ParserInfo Mode

Flesh out a command-line parser.

valuedescribeWith :: Parser a -> ParserInfo a

Flesh out command-line information using a custom Parser.

valueversionInfo :: String

A string describing the version of this benchmark (really, the version of criterion that was used to build it).