C# Class Microsoft.CodeAnalysis.Sarif.Writers.ResultLogObjectWriter

An implementation of IResultLogWriter which merely stores its results in a list.
Inheritance: IResultLogWriter
Mostra file Open project: Microsoft/sarif-sdk Class Usage Examples

Public Methods

Method Description
CloseResults ( ) : void
Initialize ( string id, string correlationId ) : void
OpenResults ( ) : void
WriteConfigurationNotifications ( IEnumerable notifications ) : void
WriteFiles ( FileData>.IDictionary fileDictionary ) : void

Write information about scanned files to the log. This information may appear after the results, as the full list of scanned files might not be known until all results have been generated.
WriteInvocation ( Invocation invocation ) : void
WriteLogicalLocations ( LogicalLocation>.IDictionary logicalLocationDictionary ) : void

Write information about the logical locations where results were produced to the log. This information may appear after the results, as the full list of logical locations will not be known until all results have been generated.
WriteResult ( System.Result result ) : void

Writes a result to the log.

This function makes a copy of the data stored in result; if a client wishes to reuse the result instance to avoid allocations they can do so. (This function may invoke an internal copy of the result or serialize it in place to disk, etc.)

WriteResults ( IEnumerable results ) : void

Writes a set of results to the log.

This function makes a copy of the data stored in results; if a client wishes to reuse the result instance to avoid allocations they can do so. (This function may invoke an internal copy of the result or serialize it in place to disk, etc.)

WriteRules ( IRule>.IDictionary rules ) : void
WriteTool ( Tool tool ) : void

Writes a tool information entry to the log.
WriteToolNotifications ( IEnumerable notifications ) : void

Method Details

CloseResults() public method

public CloseResults ( ) : void
return void

Initialize() public method

public Initialize ( string id, string correlationId ) : void
id string
correlationId string
return void

OpenResults() public method

public OpenResults ( ) : void
return void

WriteConfigurationNotifications() public method

public WriteConfigurationNotifications ( IEnumerable notifications ) : void
notifications IEnumerable
return void

WriteFiles() public method

Write information about scanned files to the log. This information may appear after the results, as the full list of scanned files might not be known until all results have been generated.
public WriteFiles ( FileData>.IDictionary fileDictionary ) : void
fileDictionary FileData>.IDictionary /// A dictionary whose keys are the strings representing the locations of scanned files /// and whose values provide information about those files. ///
return void

WriteInvocation() public method

public WriteInvocation ( Invocation invocation ) : void
invocation Invocation
return void

WriteLogicalLocations() public method

Write information about the logical locations where results were produced to the log. This information may appear after the results, as the full list of logical locations will not be known until all results have been generated.
public WriteLogicalLocations ( LogicalLocation>.IDictionary logicalLocationDictionary ) : void
logicalLocationDictionary LogicalLocation>.IDictionary /// A dictionary whose keys are strings specifying a logical location and /// whose values provide information about each component of the logical location. ///
return void

WriteResult() public method

Writes a result to the log.
This function makes a copy of the data stored in result; if a client wishes to reuse the result instance to avoid allocations they can do so. (This function may invoke an internal copy of the result or serialize it in place to disk, etc.)
/// Thrown if the tool info is not yet written. ///
public WriteResult ( System.Result result ) : void
result System.Result /// The result to write. ///
return void

WriteResults() public method

Writes a set of results to the log.
This function makes a copy of the data stored in results; if a client wishes to reuse the result instance to avoid allocations they can do so. (This function may invoke an internal copy of the result or serialize it in place to disk, etc.)
/// A file IO error occured. Clients implementing /// should allow these exceptions to propagate. /// /// Thrown if the tool info is not yet written. /// /// Thrown if is null. ///
public WriteResults ( IEnumerable results ) : void
results IEnumerable /// The results to write. ///
return void

WriteRules() public method

public WriteRules ( IRule>.IDictionary rules ) : void
rules IRule>.IDictionary
return void

WriteTool() public method

Writes a tool information entry to the log.
Thrown if the tool info block has already been /// written.
public WriteTool ( Tool tool ) : void
tool Tool The tool information to write.
return void

WriteToolNotifications() public method

public WriteToolNotifications ( IEnumerable notifications ) : void
notifications IEnumerable
return void