Struct Incident 

pub struct Incident {
    pub file_uri: String,
    pub line_number: Option<u32>,
    pub code_location: Option<Location>,
    pub message: String,
    pub code_snip: Option<String>,
    pub variables: BTreeMap<String, Value>,
    pub effort: Option<i64>,
    pub links: Vec<ExternalLink>,
    pub is_dependency_incident: bool,
}

A single match/incident found by the provider.

This is the canonical Konveyor incident type that maps to both:

• gRPC IncidentContext message (for Konveyor provider mode)
• Konveyor output incident (for analysis output consumed by fix tooling)

Fields

file_uri: String

File URI where the incident was found (e.g. file:///path/to/File.tsx).

Accepts both fileURI (gRPC/provider format) and uri (kantra output format).

line_number: Option<u32>

Line number of the match (1-indexed).

code_location: Option<Location>

Source code location (start/end positions). Present when produced by scanners, absent in kantra serialized output.

message: String

Human-readable message about the incident.

code_snip: Option<String>

Surrounding source code snippet for context.

variables: BTreeMap<String, Value>

Provider-specific variables (e.g., matched text, symbol name).

effort: Option<i64>

Optional effort override for this specific incident.

links: Vec<ExternalLink>

Associated hyperlinks.

is_dependency_incident: bool

Whether this incident is from a dependency (vs. source code).

Implementations

impl Incident

pub fn new( file_uri: String, line_number: u32, code_location: Location, ) -> Incident

Create a new incident with the minimum required fields.

pub fn with_code_snip(self, snip: String) -> Incident

Add a code snippet to the incident.

pub fn with_variable( self, key: impl Into<String>, value: impl Into<Value>, ) -> Incident

Add a variable to the incident.

Trait Implementations

impl Clone for Incident

fn clone(&self) -> Incident

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Incident

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Incident

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Incident

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

where __S: Serializer,

Serialize this value into the given Serde serializer.