Data.SARIF.Log

Provides the top-level structure of SARIF.

Documentation

data Log

Each SARIF file contains one Log value at the top.

Constructors

MkLog

Fields

• logVersion :: Text

  The version identifier of the SARIF format used by the file.

• logRuns :: [Run]

  A list of descriptions of runs of static analysis tools.

Instances

FromJSON Log

Defined in Data.SARIF.Log

Methods

parseJSON :: Value -> Parser Log

parseJSONList :: Value -> Parser [Log]

ToJSON Log

Defined in Data.SARIF.Log

Methods

toJSON :: Log -> Value

toEncoding :: Log -> Encoding

toJSONList :: [Log] -> Value

toEncodingList :: [Log] -> Encoding

Show Log

Defined in Data.SARIF.Log

Methods

showsPrec :: Int -> Log -> ShowS

show :: Log -> String

showList :: [Log] -> ShowS

Eq Log

Defined in Data.SARIF.Log

Methods

(==) :: Log -> Log -> Bool

(/=) :: Log -> Log -> Bool

defaultLog :: Log

Represents a default Log value.

decodeSarifFileStrict :: FilePath -> IO (Either String Log)

decodeSarifFileStrict filepath is a type-specialised version of eitherDecodeFileStrict for Log.

encodeSarifAsLBS :: Log -> ByteString

encodeSarifAsLBS log encodes a Log value as a lazy ByteString. This is a type-specialised version of encode.