Struct scayl::format::sarif::ReportingDescriptor

pub struct ReportingDescriptor {

    pub default_configuration: Option<ReportingConfiguration>,
    pub deprecated_guids: Option<Vec<String>>,
    pub deprecated_ids: Option<Vec<String>>,
    pub deprecated_names: Option<Vec<String>>,
    pub full_description: Option<MultiformatMessageString>,
    pub guid: Option<String>,
    pub help: Option<MultiformatMessageString>,
    pub help_uri: Option<String>,
    pub id: String,
    pub message_strings: Option<HashMap<String, MultiformatMessageString>>,
    pub name: Option<String>,
    pub properties: Option<PropertyBag>,
    pub relationships: Option<Vec<ReportingDescriptorRelationship>>,
    pub short_description: Option<MultiformatMessageString>,
}

Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.

Fields

default_configuration: Option<ReportingConfiguration>

Default reporting configuration information.

deprecated_guids: Option<Vec<String>>

An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.

deprecated_ids: Option<Vec<String>>

An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.

deprecated_names: Option<Vec<String>>

An array of readable identifiers by which this report was known in some previous version of the analysis tool.

full_description: Option<MultiformatMessageString>

A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.

guid: Option<String>

A unique identifer for the reporting descriptor in the form of a GUID.

help: Option<MultiformatMessageString>

Provides the primary documentation for the report, useful when there is no online documentation.

help_uri: Option<String>

A URI where the primary documentation for the report can be found.

id: String

A stable, opaque identifier for the report.

message_strings: Option<HashMap<String, MultiformatMessageString>>

A set of name/value pairs with arbitrary names. Each value 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.

name: Option<String>

A report identifier that is understandable to an end user.

properties: Option<PropertyBag>

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

relationships: Option<Vec<ReportingDescriptorRelationship>>

An array of objects that describe relationships between this reporting descriptor and others.

short_description: Option<MultiformatMessageString>

A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.

Trait Implementations

impl Debug for ReportingDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReportingDescriptor

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

Deserialize this value from the given Serde deserializer.

impl Serialize for ReportingDescriptor

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

Serialize this value into the given Serde serializer.