analysis

Documentation

Index

• Constants
• type Mode
  • func AllModes() []Mode
  • func ModeFromString(s string) (Mode, bool)
• type Status
  • func StatusForRunResult(r *sandbox.RunResult) Status
  • func (s Status) MarshalJSON() ([]byte, error)

Constants

const (
	// StatusCompleted indicates that the analysis run completed successfully.
	StatusCompleted = Status("completed")

	// StatusErrorTimeout indicates that the analysis was aborted due to a
	// timeout.
	StatusErrorTimeout = Status("error_timeout")

	// StatusErrorAnalysis indicates that the package being analyzed failed
	// while running the specified command.
	//
	// The Stdout and Stderr in the Result should be consulted to understand
	// further why it failed.
	StatusErrorAnalysis = Status("error_analysis")

	// StatusErrorOther indicates an error during some part of the analysis
	// excluding errors covered by other statuses.
	StatusErrorOther = Status("error_other")
)

Types

type Mode

type Mode string

Mode (analysis mode) is used to distinguish between whether static or dynamic analysis is being performed.

const (
	Dynamic Mode = "dynamic"
	Static  Mode = "static"
)

func AllModes

func AllModes() []Mode

func ModeFromString

func ModeFromString(s string) (Mode, bool)

type Status

type Status string

func StatusForRunResult

func StatusForRunResult(r *sandbox.RunResult) Status

func (Status) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.