Struct scayl::format::sarif::ToolComponent

pub struct ToolComponent {

    pub associated_component: Option<ToolComponentReference>,
    pub contents: Option<Vec<Content>>,
    pub dotted_quad_file_version: Option<String>,
    pub download_uri: Option<String>,
    pub full_description: Option<MultiformatMessageString>,
    pub full_name: Option<String>,
    pub global_message_strings: Option<HashMap<String, MultiformatMessageString>>,
    pub guid: Option<String>,
    pub information_uri: Option<String>,
    pub is_comprehensive: Option<bool>,
    pub language: Option<String>,
    pub localized_data_semantic_version: Option<String>,
    pub locations: Option<Vec<ArtifactLocation>>,
    pub minimum_required_localized_data_semantic_version: Option<String>,
    pub name: String,
    pub notifications: Option<Vec<ReportingDescriptor>>,
    pub organization: Option<String>,
    pub product: Option<String>,
    pub product_suite: Option<String>,
    pub properties: Option<PropertyBag>,
    pub release_date_utc: Option<String>,
    pub rules: Option<Vec<ReportingDescriptor>>,
    pub semantic_version: Option<String>,
    pub short_description: Option<MultiformatMessageString>,
    pub supported_taxonomies: Option<Vec<ToolComponentReference>>,
    pub taxa: Option<Vec<ReportingDescriptor>>,
    pub translation_metadata: Option<TranslationMetadata>,
    pub version: Option<String>,
}

The analysis tool that was run.

A component, such as a plug-in or the driver, of the analysis tool that was run.

The analysis tool object that will be merged with a separate run.

Fields

associated_component: Option<ToolComponentReference>

The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension’s plugin model.

contents: Option<Vec<Content>>

The kinds of data contained in this object.

dotted_quad_file_version: Option<String>

The binary version of the tool component’s primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).

download_uri: Option<String>

The absolute URI from which the tool component can be downloaded.

full_description: Option<MultiformatMessageString>

A comprehensive description of the tool component.

full_name: Option<String>

The name of the tool component along with its version and any other useful identifying information, such as its locale.

global_message_strings: Option<HashMap<String, MultiformatMessageString>>

A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

guid: Option<String>

A unique identifer for the tool component in the form of a GUID.

information_uri: Option<String>

The absolute URI at which information about this version of the tool component can be found.

is_comprehensive: Option<bool>

Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.

language: Option<String>

The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

localized_data_semantic_version: Option<String>

The semantic version of the localized strings defined in this component; maintained by components that provide translations.

locations: Option<Vec<ArtifactLocation>>

An array of the artifactLocation objects associated with the tool component.

minimum_required_localized_data_semantic_version: Option<String>

The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.

name: String

The name of the tool component.

notifications: Option<Vec<ReportingDescriptor>>

An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.

organization: Option<String>

The organization or company that produced the tool component.

product: Option<String>

A product suite to which the tool component belongs.

product_suite: Option<String>

A localizable string containing the name of the suite of products to which the tool component belongs.

properties: Option<PropertyBag>

Key/value pairs that provide additional information about the tool component.

release_date_utc: Option<String>

A string specifying the UTC date (and optionally, the time) of the component’s release.

rules: Option<Vec<ReportingDescriptor>>

An array of reportingDescriptor objects relevant to the analysis performed by the tool component.

semantic_version: Option<String>

The tool component version in the format specified by Semantic Versioning 2.0.

short_description: Option<MultiformatMessageString>

A brief description of the tool component.

supported_taxonomies: Option<Vec<ToolComponentReference>>

An array of toolComponentReference objects to declare the taxonomies supported by the tool component.

taxa: Option<Vec<ReportingDescriptor>>

An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.

translation_metadata: Option<TranslationMetadata>

Translation metadata, required for a translation, not populated by other component types.

version: Option<String>

The tool component version, in whatever format the component natively provides.

Trait Implementations

impl Debug for ToolComponent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolComponent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolComponent

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

Serialize this value into the given Serde serializer.