| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
PlutusTx.Coverage
Synopsis
- data CoverageAnnotation
- data CoverageIndex = CoverageIndex { }
- newtype CoverageMetadata = CoverageMetadata { }
- data Metadata
- newtype CoverageData = CoverageData { }
- data CoverageReport = CoverageReport { }
-
data
CovLoc
=
CovLoc
{
- _covLocFile :: String
- _covLocStartLine :: Int
- _covLocEndLine :: Int
- _covLocStartCol :: Int
- _covLocEndCol :: Int
- covLocFile :: Lens' CovLoc String
- covLocStartLine :: Lens' CovLoc Int
- covLocEndLine :: Lens' CovLoc Int
- covLocStartCol :: Lens' CovLoc Int
- covLocEndCol :: Lens' CovLoc Int
- metadataSet :: Iso' CoverageMetadata ( Set Metadata )
- coverageAnnotations :: Getter CoverageIndex ( Set CoverageAnnotation )
- ignoredAnnotations :: Getter CoverageIndex ( Set CoverageAnnotation )
- coverageMetadata :: Iso' CoverageIndex ( Map CoverageAnnotation CoverageMetadata )
- coveredAnnotations :: Iso' CoverageData ( Set CoverageAnnotation )
- addCoverageMetadata :: CoverageAnnotation -> Metadata -> CoverageIndex -> CoverageIndex
- addLocationToCoverageIndex :: MonadWriter CoverageIndex m => CovLoc -> m CoverageAnnotation
- addBoolCaseToCoverageIndex :: MonadWriter CoverageIndex m => CovLoc -> Bool -> CoverageMetadata -> m CoverageAnnotation
- coverageDataFromLogMsg :: String -> CoverageData
Documentation
data CoverageAnnotation Source #
Constructors
| CoverLocation CovLoc | |
| CoverBool CovLoc Bool |
Instances
data CoverageIndex Source #
This type keeps track of all coverage annotations and where they have been inserted / what annotations are expected to be found when executing a piece of code.
Constructors
| CoverageIndex | |
Instances
newtype CoverageMetadata Source #
Constructors
| CoverageMetadata | |
|
Fields |
|
Instances
Constructors
| ApplicationHeadSymbol String | |
| IgnoredAnnotation |
Location that is not interesting to cover. This is not generated by the
compiler, but can be added later using
|
Instances
| Eq Metadata Source # | |
| Ord Metadata Source # | |
|
Defined in PlutusTx.Coverage |
|
| Show Metadata Source # | |
| Generic Metadata Source # | |
| ToJSON Metadata Source # | |
| FromJSON Metadata Source # | |
| NFData Metadata Source # | |
|
Defined in PlutusTx.Coverage |
|
| Flat Metadata Source # | |
| Pretty Metadata Source # | |
| Serialise Metadata Source # | |
| type Rep Metadata Source # | |
|
Defined in PlutusTx.Coverage
type
Rep
Metadata
=
D1
('
MetaData
"Metadata" "PlutusTx.Coverage" "plutus-tx-1.0.0.0-4R3edYpC6C632G5Bo91y92" '
False
) (
C1
('
MetaCons
"ApplicationHeadSymbol" '
PrefixI
'
False
) (
S1
('
MetaSel
('
Nothing
::
Maybe
Symbol
) '
NoSourceUnpackedness
'
NoSourceStrictness
'
DecidedLazy
) (
Rec0
String
))
:+:
C1
('
MetaCons
"IgnoredAnnotation" '
PrefixI
'
False
) (
U1
::
Type
->
Type
))
|
|
newtype CoverageData Source #
Constructors
| CoverageData | |
|
Fields |
|
Instances
data CoverageReport Source #
Constructors
| CoverageReport | |
|
Fields |
|
Instances
A source location for coverage
Constructors
| CovLoc | |
|
Fields
|
|
Instances
metadataSet :: Iso' CoverageMetadata ( Set Metadata ) Source #
addCoverageMetadata :: CoverageAnnotation -> Metadata -> CoverageIndex -> CoverageIndex Source #
Add metadata to a coverage annotation. Does nothing if the annotation is not in the index.
addLocationToCoverageIndex :: MonadWriter CoverageIndex m => CovLoc -> m CoverageAnnotation Source #
Include a location coverage annotation in the index
addBoolCaseToCoverageIndex :: MonadWriter CoverageIndex m => CovLoc -> Bool -> CoverageMetadata -> m CoverageAnnotation Source #
Include a boolean coverage annotation in the index