Struct Invocation

pub struct Invocation {

    pub account: Option<String>,
    pub arguments: Option<Vec<String>>,
    pub command_line: Option<String>,
    pub end_time_utc: Option<String>,
    pub environment_variables: Option<BTreeMap<String, String>>,
    pub executable_location: Option<ArtifactLocation>,
    pub execution_successful: bool,
    pub exit_code: Option<i64>,
    pub exit_code_description: Option<String>,
    pub exit_signal_name: Option<String>,
    pub exit_signal_number: Option<i64>,
    pub machine: Option<String>,
    pub notification_configuration_overrides: Option<Vec<ConfigurationOverride>>,
    pub process_id: Option<i64>,
    pub process_start_failure_message: Option<String>,
    pub properties: Option<PropertyBag>,
    pub response_files: Option<Vec<ArtifactLocation>>,
    pub rule_configuration_overrides: Option<Vec<ConfigurationOverride>>,
    pub start_time_utc: Option<String>,
    pub stderr: Option<ArtifactLocation>,
    pub stdin: Option<ArtifactLocation>,
    pub stdout: Option<ArtifactLocation>,
    pub stdout_stderr: Option<ArtifactLocation>,
    pub tool_configuration_notifications: Option<Vec<Notification>>,
    pub tool_execution_notifications: Option<Vec<Notification>>,
    pub working_directory: Option<ArtifactLocation>,
}

The runtime environment of the analysis tool run.

Fields

account: Option<String>

The account under which the invocation occurred.

arguments: Option<Vec<String>>

An array of strings, containing in order the command line arguments passed to the tool from the operating system.

command_line: Option<String>

The command line used to invoke the tool.

end_time_utc: Option<String>

The Coordinated Universal Time (UTC) date and time at which the invocation ended. See “Date/time properties” in the SARIF spec for the required format.

environment_variables: Option<BTreeMap<String, String>>

The environment variables associated with the analysis tool process, expressed as key/value pairs.

executable_location: Option<ArtifactLocation>

An absolute URI specifying the location of the executable that was invoked.

execution_successful: bool

Specifies whether the tool’s execution completed successfully.

exit_code: Option<i64>

The process exit code.

exit_code_description: Option<String>

The reason for the process exit.

exit_signal_name: Option<String>

The name of the signal that caused the process to exit.

exit_signal_number: Option<i64>

The numeric value of the signal that caused the process to exit.

machine: Option<String>

The machine on which the invocation occurred.

notification_configuration_overrides: Option<Vec<ConfigurationOverride>>

An array of configurationOverride objects that describe notifications related runtime overrides.

process_id: Option<i64>

The id of the process in which the invocation occurred.

process_start_failure_message: Option<String>

The reason given by the operating system that the process failed to start.

properties: Option<PropertyBag>

Key/value pairs that provide additional information about the invocation.

response_files: Option<Vec<ArtifactLocation>>

The locations of any response files specified on the tool’s command line.

rule_configuration_overrides: Option<Vec<ConfigurationOverride>>

An array of configurationOverride objects that describe rules related runtime overrides.

start_time_utc: Option<String>

The Coordinated Universal Time (UTC) date and time at which the invocation started. See “Date/time properties” in the SARIF spec for the required format.

stderr: Option<ArtifactLocation>

A file containing the standard error stream from the process that was invoked.

stdin: Option<ArtifactLocation>

A file containing the standard input stream to the process that was invoked.

stdout: Option<ArtifactLocation>

A file containing the standard output stream from the process that was invoked.

stdout_stderr: Option<ArtifactLocation>

A file containing the interleaved standard output and standard error stream from the process that was invoked.

tool_configuration_notifications: Option<Vec<Notification>>

A list of conditions detected by the tool that are relevant to the tool’s configuration.

tool_execution_notifications: Option<Vec<Notification>>

A list of runtime conditions detected by the tool during the analysis.

working_directory: Option<ArtifactLocation>

The working directory for the invocation.

Implementations

impl Invocation

pub fn builder() -> InvocationBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building Invocation. On the builder, call .account(...)(optional), .arguments(...)(optional), .command_line(...)(optional), .end_time_utc(...)(optional), .environment_variables(...)(optional), .executable_location(...)(optional), .execution_successful(...), .exit_code(...)(optional), .exit_code_description(...)(optional), .exit_signal_name(...)(optional), .exit_signal_number(...)(optional), .machine(...)(optional), .notification_configuration_overrides(...)(optional), .process_id(...)(optional), .process_start_failure_message(...)(optional), .properties(...)(optional), .response_files(...)(optional), .rule_configuration_overrides(...)(optional), .start_time_utc(...)(optional), .stderr(...)(optional), .stdin(...)(optional), .stdout(...)(optional), .stdout_stderr(...)(optional), .tool_configuration_notifications(...)(optional), .tool_execution_notifications(...)(optional), .working_directory(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Invocation.

Trait Implementations

impl Clone for Invocation

fn clone(&self) -> Invocation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Invocation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Invocation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Invocation

fn eq(&self, other: &Invocation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Invocation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Invocation