Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.SARIF.Tool

Description

Provides the Tool type which is used to describe static analysis tools.

Synopsis

Documentation

data Tool Source #

Used to describe static analysis tools.

Constructors

MkTool
Fields toolDriver :: ToolComponent The description of the tool itself. toolExtensions :: [ToolComponent] Descriptions of any extensions to the tool that were used.

Instances

Instances details

FromJSON Tool Source #
Instance details Defined in Data.SARIF.Tool Methods parseJSON :: Value -> Parser Tool # parseJSONList :: Value -> Parser [Tool] #
ToJSON Tool Source #
Instance details Defined in Data.SARIF.Tool Methods toJSON :: Tool -> Value # toEncoding :: Tool -> Encoding # toJSONList :: [Tool] -> Value # toEncodingList :: [Tool] -> Encoding #
Generic Tool Source #
Instance details Defined in Data.SARIF.Tool Associated Types type Rep Tool :: Type -> Type # Methods from :: Tool -> Rep Tool x # to :: Rep Tool x -> Tool #
Show Tool Source #
Instance details Defined in Data.SARIF.Tool Methods showsPrec :: Int -> Tool -> ShowS # show :: Tool -> String # showList :: [Tool] -> ShowS #
Eq Tool Source #
Instance details Defined in Data.SARIF.Tool Methods (==) :: Tool -> Tool -> Bool # (/=) :: Tool -> Tool -> Bool #
type Rep Tool Source #
Instance details Defined in Data.SARIF.Tool type Rep Tool = D1 ('MetaData "Tool" "Data.SARIF.Tool" "sarif-0.1-6R1G6flmlpN5N6lqtlywVb" 'False) (C1 ('MetaCons "MkTool" 'PrefixI 'True) (S1 ('MetaSel ('Just "toolDriver") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ToolComponent) :*: S1 ('MetaSel ('Just "toolExtensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ToolComponent])))

data ToolComponent Source #

A description of a tool component, such as a static analysis tool or an extension to one.

Constructors

MkToolComponent

Fields

toolComponentName :: Maybe Text
The short name of the tool component.
toolComponentFullName :: Maybe Text
The full name of the tool component.
toolComponentSemanticVersion :: Maybe Text
The semver of the tool component.
toolComponentVersion :: Maybe Text
The version of the tool component.
toolComponentGUID :: Maybe UUID
A GUID which identifies the tool component.
toolComponentInformationUri :: Maybe Text
A URI pointing to more information about the tool component.
toolComponentRules :: [ReportingDescriptor]
A list of rules that the tool component applies.

Instances

Instances details

FromJSON ToolComponent Source #
Instance details Defined in Data.SARIF.Tool Methods parseJSON :: Value -> Parser ToolComponent # parseJSONList :: Value -> Parser [ToolComponent] #
ToJSON ToolComponent Source #
Instance details Defined in Data.SARIF.Tool Methods toJSON :: ToolComponent -> Value # toEncoding :: ToolComponent -> Encoding # toJSONList :: [ToolComponent] -> Value # toEncodingList :: [ToolComponent] -> Encoding #
Generic ToolComponent Source #
Instance details Defined in Data.SARIF.Tool Associated Types type Rep ToolComponent :: Type -> Type # Methods from :: ToolComponent -> Rep ToolComponent x # to :: Rep ToolComponent x -> ToolComponent #
Show ToolComponent Source #
Instance details Defined in Data.SARIF.Tool Methods showsPrec :: Int -> ToolComponent -> ShowS # show :: ToolComponent -> String # showList :: [ToolComponent] -> ShowS #
Eq ToolComponent Source #
Instance details Defined in Data.SARIF.Tool Methods (==) :: ToolComponent -> ToolComponent -> Bool # (/=) :: ToolComponent -> ToolComponent -> Bool #
type Rep ToolComponent Source #
Instance details Defined in Data.SARIF.Tool type Rep ToolComponent = D1 ('MetaData "ToolComponent" "Data.SARIF.Tool" "sarif-0.1-6R1G6flmlpN5N6lqtlywVb" 'False) (C1 ('MetaCons "MkToolComponent" 'PrefixI 'True) ((S1 ('MetaSel ('Just "toolComponentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "toolComponentFullName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "toolComponentSemanticVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "toolComponentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "toolComponentGUID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UUID))) :: (S1 ('MetaSel ('Just "toolComponentInformationUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "toolComponentRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ReportingDescriptor])))))

defaultToolComponent :: ToolComponent Source #

defaultToolComponent is a default value of the ToolComponent type.