Copyright | (c) 2009-2014 Bryan O'Sullivan |
---|---|
License | BSD-style |
Maintainer | bos@serpentine.com |
Stability | experimental |
Portability | GHC |
Safe Haskell | Trustworthy |
Language | Haskell2010 |
Criterion.Report
Contents
Description
Reporting functions.
Synopsis
- formatReport :: [Report] -> Text -> IO Text
- report :: [Report] -> Criterion ()
- tidyTails :: KDE -> KDE
- data TemplateException = TemplateNotFound FilePath
- loadTemplate :: [FilePath] -> FilePath -> IO Text
- includeFile :: MonadIO m => [FilePath] -> FilePath -> m Text
- getTemplateDir :: IO FilePath
- vector :: (Vector v a, ToJSON a) => Text -> v a -> Value
- vector2 :: (Vector v a, Vector v b, ToJSON a, ToJSON b) => Text -> Text -> v a -> v b -> Value
Documentation
Arguments
:: [Report] | |
-> Text | Mustache template. |
-> IO Text |
Format a series of Report
values using the given Mustache template.
report :: [Report] -> Criterion () Source #
Write out a series of Report
values to a single file, if
configured to do so.
Rendering helper functions
data TemplateException Source #
A problem arose with a template.
Constructors
TemplateNotFound FilePath | The template could not be found. |
Instances
Data TemplateException Source # | |
Defined in Criterion.Report Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TemplateException -> c TemplateException gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TemplateException toConstr :: TemplateException -> Constr dataTypeOf :: TemplateException -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TemplateException) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TemplateException) gmapT :: (forall b. Data b => b -> b) -> TemplateException -> TemplateException gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TemplateException -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TemplateException -> r gmapQ :: (forall d. Data d => d -> u) -> TemplateException -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> TemplateException -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> TemplateException -> m TemplateException gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TemplateException -> m TemplateException gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TemplateException -> m TemplateException | |
Exception TemplateException Source # | |
Defined in Criterion.Report Methods toException :: TemplateException -> SomeException fromException :: SomeException -> Maybe TemplateException displayException :: TemplateException -> String | |
Generic TemplateException Source # | |
Defined in Criterion.Report Associated Types type Rep TemplateException :: Type -> Type Methods from :: TemplateException -> Rep TemplateException x to :: Rep TemplateException x -> TemplateException | |
Read TemplateException Source # | |
Defined in Criterion.Report Methods readsPrec :: Int -> ReadS TemplateException readList :: ReadS [TemplateException] readPrec :: ReadPrec TemplateException readListPrec :: ReadPrec [TemplateException] | |
Show TemplateException Source # | |
Defined in Criterion.Report Methods showsPrec :: Int -> TemplateException -> ShowS show :: TemplateException -> String showList :: [TemplateException] -> ShowS | |
Eq TemplateException Source # | |
Defined in Criterion.Report Methods (==) :: TemplateException -> TemplateException -> Bool (/=) :: TemplateException -> TemplateException -> Bool | |
type Rep TemplateException Source # | |
Defined in Criterion.Report type Rep TemplateException = D1 ('MetaData "TemplateException" "Criterion.Report" "criterion-1.6.1.0-2h8jJxyb3zL8Vx5Ow7sziS" 'False) (C1 ('MetaCons "TemplateNotFound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath))) |
Arguments
:: [FilePath] | Search path. |
-> FilePath | Name of template file. |
-> IO Text |
Load a Mustache template file.
If the name is an absolute or relative path, the search path is not used, and the name is treated as a literal path.
If the -fembed-data-files
Cabal
flag is enabled, this also checks
the embedded data-files
from criterion.cabal
.
This function throws a TemplateException
if the template could
not be found, or an IOException
if no template could be loaded.
Arguments
:: MonadIO m | |
=> [FilePath] | Directories to search. |
-> FilePath | Name of the file to search for. |
-> m Text |
Attempt to include the contents of a file based on a search path.
Returns empty
if the search fails or the file could not be read.
Intended for preprocessing Mustache files, e.g. replacing sections
{{#include}}file.txt{{/include}
with file contents.
getTemplateDir :: IO FilePath Source #
Return the path to the template and other files used for generating reports.
When the -fembed-data-files
Cabal
flag is enabled, this simply
returns the empty path.
Arguments
:: (Vector v a, ToJSON a) | |
=> Text | Name to use when substituting. |
-> v a | |
-> Value |
Render the elements of a vector.
It will substitute each value in the vector for x
in the
following Mustache template:
{{#foo}} {{x}} {{/foo}}