Data.SARIF.MultiformatMessageString

Provides the MultiformatMessageString type which is used to represent messages in different formats, such as text or markdown.

Documentation

data MultiformatMessageString

Represents a message in at least textual representation, but also allowing it to be provided in other formats such as markdown.

Constructors

MkMultiformatMessageString

Fields

• mmsText :: Text

  A textual representation of the message, which is mandatory.

• mmsMarkdown :: Maybe Text

  Optionally, a markdown representation of the message.

Instances

FromJSON MultiformatMessageString

Defined in Data.SARIF.MultiformatMessageString

Methods

parseJSON :: Value -> Parser MultiformatMessageString

parseJSONList :: Value -> Parser [MultiformatMessageString]

ToJSON MultiformatMessageString

Defined in Data.SARIF.MultiformatMessageString

Methods

toJSON :: MultiformatMessageString -> Value

toEncoding :: MultiformatMessageString -> Encoding

toJSONList :: [MultiformatMessageString] -> Value

toEncodingList :: [MultiformatMessageString] -> Encoding

Show MultiformatMessageString

Defined in Data.SARIF.MultiformatMessageString

Methods

showsPrec :: Int -> MultiformatMessageString -> ShowS

show :: MultiformatMessageString -> String

showList :: [MultiformatMessageString] -> ShowS

Eq MultiformatMessageString

Defined in Data.SARIF.MultiformatMessageString

Methods

(==) :: MultiformatMessageString -> MultiformatMessageString -> Bool

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

defaultMultiformatMessageString :: Text -> MultiformatMessageString

defaultMultiformatMessageString messageText constructs a MultiformatMessageString value where messageText is the textual representation of the message.