| Safe Haskell | None |
|---|---|
| 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
| FromJSON CoverageIndex Source # | |||||
Defined in PlutusTx.Coverage | |||||
| ToJSON CoverageIndex Source # | |||||
Defined in PlutusTx.Coverage Methods toJSON :: CoverageIndex -> Value toEncoding :: CoverageIndex -> Encoding toJSONList :: [CoverageIndex] -> Value toEncodingList :: [CoverageIndex] -> Encoding omitField :: CoverageIndex -> Bool | |||||
| Monoid CoverageIndex Source # | |||||
Defined in PlutusTx.Coverage Methods mempty :: CoverageIndex Source # mappend :: CoverageIndex -> CoverageIndex -> CoverageIndex Source # mconcat :: [CoverageIndex] -> CoverageIndex Source # | |||||
| Semigroup CoverageIndex Source # | |||||
Defined in PlutusTx.Coverage Methods (<>) :: CoverageIndex -> CoverageIndex -> CoverageIndex Source # sconcat :: NonEmpty CoverageIndex -> CoverageIndex Source # stimes :: Integral b => b -> CoverageIndex -> CoverageIndex Source # | |||||
| Generic CoverageIndex Source # | |||||
Defined in PlutusTx.Coverage Associated Types
Methods from :: CoverageIndex -> Rep CoverageIndex x Source # to :: Rep CoverageIndex x -> CoverageIndex Source # | |||||
| Show CoverageIndex Source # | |||||
Defined in PlutusTx.Coverage | |||||
| NFData CoverageIndex Source # | |||||
Defined in PlutusTx.Coverage Methods rnf :: CoverageIndex -> () Source # | |||||
| Eq CoverageIndex Source # | |||||
Defined in PlutusTx.Coverage Methods (==) :: CoverageIndex -> CoverageIndex -> Bool Source # (/=) :: CoverageIndex -> CoverageIndex -> Bool Source # | |||||
| Ord CoverageIndex Source # | |||||
Defined in PlutusTx.Coverage Methods compare :: CoverageIndex -> CoverageIndex -> Ordering Source # (<) :: CoverageIndex -> CoverageIndex -> Bool Source # (<=) :: CoverageIndex -> CoverageIndex -> Bool Source # (>) :: CoverageIndex -> CoverageIndex -> Bool Source # (>=) :: CoverageIndex -> CoverageIndex -> Bool Source # max :: CoverageIndex -> CoverageIndex -> CoverageIndex Source # min :: CoverageIndex -> CoverageIndex -> CoverageIndex Source # | |||||
| Flat CoverageIndex Source # | |||||
Defined in PlutusTx.Coverage Methods encode :: CoverageIndex -> Encoding decode :: Get CoverageIndex size :: CoverageIndex -> NumBits -> NumBits | |||||
| Serialise CoverageIndex Source # | |||||
Defined in PlutusTx.Coverage Methods encode :: CoverageIndex -> Encoding decode :: Decoder s CoverageIndex encodeList :: [CoverageIndex] -> Encoding decodeList :: Decoder s [CoverageIndex] | |||||
| type Rep CoverageIndex Source # | |||||
Defined in PlutusTx.Coverage type Rep CoverageIndex = D1 ('MetaData "CoverageIndex" "PlutusTx.Coverage" "plutus-tx-1.60.0.0-2VI8qZOpowK2Zo3DTnqORk" 'True) (C1 ('MetaCons "CoverageIndex" 'PrefixI 'True) (S1 ('MetaSel ('Just "_coverageMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map CoverageAnnotation CoverageMetadata)))) | |||||
newtype CoverageMetadata Source #
Constructors
| CoverageMetadata | |
Fields | |
Instances
| FromJSON CoverageMetadata Source # | |||||
Defined in PlutusTx.Coverage Methods parseJSON :: Value -> Parser CoverageMetadata parseJSONList :: Value -> Parser [CoverageMetadata] | |||||
| ToJSON CoverageMetadata Source # | |||||
Defined in PlutusTx.Coverage Methods toJSON :: CoverageMetadata -> Value toEncoding :: CoverageMetadata -> Encoding toJSONList :: [CoverageMetadata] -> Value toEncodingList :: [CoverageMetadata] -> Encoding omitField :: CoverageMetadata -> Bool | |||||
| Monoid CoverageMetadata Source # | |||||
Defined in PlutusTx.Coverage Methods mempty :: CoverageMetadata Source # mappend :: CoverageMetadata -> CoverageMetadata -> CoverageMetadata Source # mconcat :: [CoverageMetadata] -> CoverageMetadata Source # | |||||
| Semigroup CoverageMetadata Source # | |||||
Defined in PlutusTx.Coverage Methods (<>) :: CoverageMetadata -> CoverageMetadata -> CoverageMetadata Source # sconcat :: NonEmpty CoverageMetadata -> CoverageMetadata Source # stimes :: Integral b => b -> CoverageMetadata -> CoverageMetadata Source # | |||||
| Generic CoverageMetadata Source # | |||||
Defined in PlutusTx.Coverage Associated Types
Methods from :: CoverageMetadata -> Rep CoverageMetadata x Source # to :: Rep CoverageMetadata x -> CoverageMetadata Source # | |||||
| Show CoverageMetadata Source # | |||||
Defined in PlutusTx.Coverage | |||||
| NFData CoverageMetadata Source # | |||||
Defined in PlutusTx.Coverage Methods rnf :: CoverageMetadata -> () Source # | |||||
| Eq CoverageMetadata Source # | |||||
Defined in PlutusTx.Coverage Methods (==) :: CoverageMetadata -> CoverageMetadata -> Bool Source # (/=) :: CoverageMetadata -> CoverageMetadata -> Bool Source # | |||||
| Ord CoverageMetadata Source # | |||||
Defined in PlutusTx.Coverage Methods compare :: CoverageMetadata -> CoverageMetadata -> Ordering Source # (<) :: CoverageMetadata -> CoverageMetadata -> Bool Source # (<=) :: CoverageMetadata -> CoverageMetadata -> Bool Source # (>) :: CoverageMetadata -> CoverageMetadata -> Bool Source # (>=) :: CoverageMetadata -> CoverageMetadata -> Bool Source # max :: CoverageMetadata -> CoverageMetadata -> CoverageMetadata Source # min :: CoverageMetadata -> CoverageMetadata -> CoverageMetadata Source # | |||||
| Flat CoverageMetadata Source # | |||||
Defined in PlutusTx.Coverage Methods encode :: CoverageMetadata -> Encoding decode :: Get CoverageMetadata size :: CoverageMetadata -> NumBits -> NumBits | |||||
| Pretty CoverageMetadata Source # | |||||
Defined in PlutusTx.Coverage | |||||
| Serialise CoverageMetadata Source # | |||||
Defined in PlutusTx.Coverage Methods encode :: CoverageMetadata -> Encoding decode :: Decoder s CoverageMetadata encodeList :: [CoverageMetadata] -> Encoding decodeList :: Decoder s [CoverageMetadata] | |||||
| type Rep CoverageMetadata Source # | |||||
Defined in PlutusTx.Coverage type Rep CoverageMetadata = D1 ('MetaData "CoverageMetadata" "PlutusTx.Coverage" "plutus-tx-1.60.0.0-2VI8qZOpowK2Zo3DTnqORk" 'True) (C1 ('MetaCons "CoverageMetadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "_metadataSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Metadata)))) | |||||
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 # | |||||
Defined in PlutusTx.Coverage Associated Types
| |||||
| Show Metadata Source # | |||||
| NFData Metadata Source # | |||||
Defined in PlutusTx.Coverage | |||||
| Eq Metadata Source # | |||||
| Ord Metadata Source # | |||||
Defined in PlutusTx.Coverage | |||||
| Flat Metadata Source # | |||||
| Pretty Metadata Source # | |||||
Defined in PlutusTx.Coverage | |||||
| Serialise Metadata Source # | |||||
Defined in PlutusTx.Coverage Methods encode :: Metadata -> Encoding encodeList :: [Metadata] -> Encoding decodeList :: Decoder s [Metadata] | |||||
| type Rep Metadata Source # | |||||
Defined in PlutusTx.Coverage type Rep Metadata = D1 ('MetaData "Metadata" "PlutusTx.Coverage" "plutus-tx-1.60.0.0-2VI8qZOpowK2Zo3DTnqORk" '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
| FromJSON CoverageData Source # | |||||
Defined in PlutusTx.Coverage | |||||
| ToJSON CoverageData Source # | |||||
Defined in PlutusTx.Coverage Methods toJSON :: CoverageData -> Value toEncoding :: CoverageData -> Encoding toJSONList :: [CoverageData] -> Value toEncodingList :: [CoverageData] -> Encoding omitField :: CoverageData -> Bool | |||||
| Monoid CoverageData Source # | |||||
Defined in PlutusTx.Coverage Methods mempty :: CoverageData Source # mappend :: CoverageData -> CoverageData -> CoverageData Source # mconcat :: [CoverageData] -> CoverageData Source # | |||||
| Semigroup CoverageData Source # | |||||
Defined in PlutusTx.Coverage Methods (<>) :: CoverageData -> CoverageData -> CoverageData Source # sconcat :: NonEmpty CoverageData -> CoverageData Source # stimes :: Integral b => b -> CoverageData -> CoverageData Source # | |||||
| Generic CoverageData Source # | |||||
Defined in PlutusTx.Coverage Associated Types
Methods from :: CoverageData -> Rep CoverageData x Source # to :: Rep CoverageData x -> CoverageData Source # | |||||
| Show CoverageData Source # | |||||
Defined in PlutusTx.Coverage | |||||
| NFData CoverageData Source # | |||||
Defined in PlutusTx.Coverage Methods rnf :: CoverageData -> () Source # | |||||
| Eq CoverageData Source # | |||||
Defined in PlutusTx.Coverage Methods (==) :: CoverageData -> CoverageData -> Bool Source # (/=) :: CoverageData -> CoverageData -> Bool Source # | |||||
| Ord CoverageData Source # | |||||
Defined in PlutusTx.Coverage Methods compare :: CoverageData -> CoverageData -> Ordering Source # (<) :: CoverageData -> CoverageData -> Bool Source # (<=) :: CoverageData -> CoverageData -> Bool Source # (>) :: CoverageData -> CoverageData -> Bool Source # (>=) :: CoverageData -> CoverageData -> Bool Source # max :: CoverageData -> CoverageData -> CoverageData Source # min :: CoverageData -> CoverageData -> CoverageData Source # | |||||
| type Rep CoverageData Source # | |||||
Defined in PlutusTx.Coverage type Rep CoverageData = D1 ('MetaData "CoverageData" "PlutusTx.Coverage" "plutus-tx-1.60.0.0-2VI8qZOpowK2Zo3DTnqORk" 'True) (C1 ('MetaCons "CoverageData" 'PrefixI 'True) (S1 ('MetaSel ('Just "_coveredAnnotations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set CoverageAnnotation)))) | |||||
data CoverageReport Source #
Constructors
| CoverageReport | |
Fields | |
Instances
| FromJSON CoverageReport Source # | |||||
Defined in PlutusTx.Coverage | |||||
| ToJSON CoverageReport Source # | |||||
Defined in PlutusTx.Coverage Methods toJSON :: CoverageReport -> Value toEncoding :: CoverageReport -> Encoding toJSONList :: [CoverageReport] -> Value toEncodingList :: [CoverageReport] -> Encoding omitField :: CoverageReport -> Bool | |||||
| Monoid CoverageReport Source # | |||||
Defined in PlutusTx.Coverage Methods mempty :: CoverageReport Source # mappend :: CoverageReport -> CoverageReport -> CoverageReport Source # mconcat :: [CoverageReport] -> CoverageReport Source # | |||||
| Semigroup CoverageReport Source # | |||||
Defined in PlutusTx.Coverage Methods (<>) :: CoverageReport -> CoverageReport -> CoverageReport Source # sconcat :: NonEmpty CoverageReport -> CoverageReport Source # stimes :: Integral b => b -> CoverageReport -> CoverageReport Source # | |||||
| Generic CoverageReport Source # | |||||
Defined in PlutusTx.Coverage Associated Types
Methods from :: CoverageReport -> Rep CoverageReport x Source # to :: Rep CoverageReport x -> CoverageReport Source # | |||||
| Show CoverageReport Source # | |||||
Defined in PlutusTx.Coverage | |||||
| NFData CoverageReport Source # | |||||
Defined in PlutusTx.Coverage Methods rnf :: CoverageReport -> () Source # | |||||
| Eq CoverageReport Source # | |||||
Defined in PlutusTx.Coverage Methods (==) :: CoverageReport -> CoverageReport -> Bool Source # (/=) :: CoverageReport -> CoverageReport -> Bool Source # | |||||
| Ord CoverageReport Source # | |||||
Defined in PlutusTx.Coverage Methods compare :: CoverageReport -> CoverageReport -> Ordering Source # (<) :: CoverageReport -> CoverageReport -> Bool Source # (<=) :: CoverageReport -> CoverageReport -> Bool Source # (>) :: CoverageReport -> CoverageReport -> Bool Source # (>=) :: CoverageReport -> CoverageReport -> Bool Source # max :: CoverageReport -> CoverageReport -> CoverageReport Source # min :: CoverageReport -> CoverageReport -> CoverageReport Source # | |||||
| Pretty CoverageReport Source # | |||||
Defined in PlutusTx.Coverage | |||||
| type Rep CoverageReport Source # | |||||
Defined in PlutusTx.Coverage type Rep CoverageReport = D1 ('MetaData "CoverageReport" "PlutusTx.Coverage" "plutus-tx-1.60.0.0-2VI8qZOpowK2Zo3DTnqORk" 'False) (C1 ('MetaCons "CoverageReport" 'PrefixI 'True) (S1 ('MetaSel ('Just "_coverageIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CoverageIndex) :*: S1 ('MetaSel ('Just "_coverageData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CoverageData))) | |||||
A source location for coverage
Constructors
| CovLoc | |
Fields
| |
Instances
| FromJSON CovLoc Source # | |||||
Defined in PlutusTx.Coverage | |||||
| ToJSON CovLoc Source # | |||||
Defined in PlutusTx.Coverage Methods toEncoding :: CovLoc -> Encoding toJSONList :: [CovLoc] -> Value toEncodingList :: [CovLoc] -> Encoding | |||||
| Generic CovLoc Source # | |||||
Defined in PlutusTx.Coverage Associated Types
| |||||
| Read CovLoc Source # | |||||
| Show CovLoc Source # | |||||
| NFData CovLoc Source # | |||||
Defined in PlutusTx.Coverage | |||||
| Eq CovLoc Source # | |||||
| Ord CovLoc Source # | |||||
| Flat CovLoc Source # | |||||
| Pretty CovLoc Source # | |||||
Defined in PlutusTx.Coverage | |||||
| Serialise CovLoc Source # | |||||
Defined in PlutusTx.Coverage | |||||
| type Rep CovLoc Source # | |||||
Defined in PlutusTx.Coverage type Rep CovLoc = D1 ('MetaData "CovLoc" "PlutusTx.Coverage" "plutus-tx-1.60.0.0-2VI8qZOpowK2Zo3DTnqORk" 'False) (C1 ('MetaCons "CovLoc" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_covLocFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String) :*: S1 ('MetaSel ('Just "_covLocStartLine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "_covLocEndLine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "_covLocStartCol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "_covLocEndCol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))) | |||||
covLocFile :: Lens' CovLoc String Source #
covLocStartLine :: Lens' CovLoc Int Source #
covLocEndLine :: Lens' CovLoc Int Source #
covLocStartCol :: Lens' CovLoc Int Source #
covLocEndCol :: Lens' CovLoc Int Source #
metadataSet :: Iso' CoverageMetadata (Set Metadata) Source #
coverageAnnotations :: Getter CoverageIndex (Set CoverageAnnotation) Source #
ignoredAnnotations :: Getter CoverageIndex (Set CoverageAnnotation) Source #
coveredAnnotations :: Iso' CoverageData (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