| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
PlutusTx.Coverage
Synopsis
- data CoverageAnnotation
- newtype CoverageIndex = CoverageIndex {}
- newtype CoverageMetadata = CoverageMetadata {}
- data Metadata
- newtype CoverageData = CoverageData {}
- data CoverageReport = CoverageReport {}
- data CovLoc = CovLoc {}
- 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
newtype 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
| FromJSON Metadata Source # | |
Defined in PlutusTx.Coverage | |
| ToJSON Metadata Source # | |
Defined in PlutusTx.Coverage Methods toEncoding ∷ Metadata → Encoding toJSONList ∷ [Metadata] → Value toEncodingList ∷ [Metadata] → Encoding | |
| Generic Metadata Source # | |
| Show Metadata Source # | |
| NFData Metadata Source # | |
Defined in PlutusTx.Coverage | |
| Flat Metadata Source # | |
| Eq Metadata Source # | |
| Ord 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.34.1.0-inplace" 'False) (C1 ('MetaCons "ApplicationHeadSymbol" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (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 #
coverageAnnotations ∷ Getter CoverageIndex (Set CoverageAnnotation) Source #
ignoredAnnotations ∷ Getter CoverageIndex (Set CoverageAnnotation) 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