Data.SARIF.Location

Provides types used to refer to different sorts of locations, such as files, as well as parts of files.

Documentation

newtype Location

Represents locations.

Constructors

MkLocation

Fields

• locationPhysicalLocation :: Maybe PhysicalLocation

  The physical location (i.e. part of a file) to which this location refers to.

Instances

FromJSON Location

Defined in Data.SARIF.Location

Methods

parseJSON :: Value -> Parser Location

parseJSONList :: Value -> Parser [Location]

ToJSON Location

Defined in Data.SARIF.Location

Methods

toJSON :: Location -> Value

toEncoding :: Location -> Encoding

toJSONList :: [Location] -> Value

toEncodingList :: [Location] -> Encoding

Show Location

Defined in Data.SARIF.Location

Methods

showsPrec :: Int -> Location -> ShowS

show :: Location -> String

showList :: [Location] -> ShowS

Eq Location

Defined in Data.SARIF.Location

Methods

(==) :: Location -> Location -> Bool

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

newtype ArtifactLocation

Represents artifact locations such as file paths.

Constructors

MkArtifactLocation

Fields

• artifactLocationUri :: Text

Instances

FromJSON ArtifactLocation

Defined in Data.SARIF.Location

Methods

parseJSON :: Value -> Parser ArtifactLocation

parseJSONList :: Value -> Parser [ArtifactLocation]

ToJSON ArtifactLocation

Defined in Data.SARIF.Location

Methods

toJSON :: ArtifactLocation -> Value

toEncoding :: ArtifactLocation -> Encoding

toJSONList :: [ArtifactLocation] -> Value

toEncodingList :: [ArtifactLocation] -> Encoding

Show ArtifactLocation

Defined in Data.SARIF.Location

Methods

showsPrec :: Int -> ArtifactLocation -> ShowS

show :: ArtifactLocation -> String

showList :: [ArtifactLocation] -> ShowS

Eq ArtifactLocation

Defined in Data.SARIF.Location

Methods

(==) :: ArtifactLocation -> ArtifactLocation -> Bool

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

data Region

Represents regions of code with a start and an end.

Constructors

MkRegion

Fields

• regionStartLine :: Int

  The line on which this region starts.

• regionStartColumn :: Int

  The column within the starting line where this region starts.

• regionEndLine :: Int

  The line on which this region ends.

• regionEndColumn :: Int

  The column within the ending line where this region ends.

Instances

FromJSON Region

Defined in Data.SARIF.Location

Methods

parseJSON :: Value -> Parser Region

parseJSONList :: Value -> Parser [Region]

ToJSON Region

Defined in Data.SARIF.Location

Methods

toJSON :: Region -> Value

toEncoding :: Region -> Encoding

toJSONList :: [Region] -> Value

toEncodingList :: [Region] -> Encoding

Show Region

Defined in Data.SARIF.Location

Methods

showsPrec :: Int -> Region -> ShowS

show :: Region -> String

showList :: [Region] -> ShowS

Eq Region

Defined in Data.SARIF.Location

Methods

(==) :: Region -> Region -> Bool

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

data PhysicalLocation

Represents parts of artifacts, e.g. a Region within a file.

Constructors

MkPhysicalLocation

Fields

• physicalLocationArtifactLocation :: ArtifactLocation
• physicalLocationRegion :: Region

Instances

FromJSON PhysicalLocation

Defined in Data.SARIF.Location

Methods

parseJSON :: Value -> Parser PhysicalLocation

parseJSONList :: Value -> Parser [PhysicalLocation]

ToJSON PhysicalLocation

Defined in Data.SARIF.Location

Methods

toJSON :: PhysicalLocation -> Value

toEncoding :: PhysicalLocation -> Encoding

toJSONList :: [PhysicalLocation] -> Value

toEncodingList :: [PhysicalLocation] -> Encoding

Show PhysicalLocation

Defined in Data.SARIF.Location

Methods

showsPrec :: Int -> PhysicalLocation -> ShowS

show :: PhysicalLocation -> String

showList :: [PhysicalLocation] -> ShowS

Eq PhysicalLocation

Defined in Data.SARIF.Location

Methods

(==) :: PhysicalLocation -> PhysicalLocation -> Bool

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