Struct FindingKey 

pub struct FindingKey { /* private fields */ }

A finding’s stable identity across runs.

The key is finding:<analyzer>:<component>… — the analyzer id followed by that analyzer’s own ordered identity components. The schema deliberately does not know what those components mean, so a new analyzer is a new recipe in its adapter rather than a schema change:

finding:semgrep:<rule>:<path>:<start-byte>:<snippet-hash>
finding:cargo-audit:<advisory>:<pkg>:<version>:<lockfile-blob>

Components may themselves contain : (a rule id with a namespace, a Windows path), so on rendering \ and : are escaped with a backslash. Parsing reverses that exactly, which makes the rendering injective: two different component lists can never collide on one key.

Implementations

impl FindingKey

pub fn new<S: AsRef<str>>( analyzer: &str, parts: &[S], ) -> Result<Self, FindingsError>

Build a key from an analyzer id and its ordered identity components.

Errors

Returns FindingsError::InvalidAnalyzerId if analyzer is not 1..= MAX_ANALYZER_ID characters of lowercase [a-z0-9._-], FindingsError::EmptyIdentity if parts is empty, or FindingsError::InvalidIdentityPart if a component is empty, longer than MAX_IDENTITY_PART, or contains a control character.

pub fn analyzer(&self) -> &str

The analyzer that produced the finding.

pub fn parts(&self) -> &[String]

The analyzer-specific identity components, in order.

pub fn render(&self) -> String

Render the key to its stable string form.

pub fn parse(rendered: &str) -> Result<Self, FindingsError>

Parse a rendered key back into its components — the exact inverse of FindingKey::render.

Errors

Returns FindingsError::MalformedKey if the prefix is wrong, an escape is dangling, or there is no identity component; or the same validation errors FindingKey::new raises.

Trait Implementations

impl Clone for FindingKey

fn clone(&self) -> FindingKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FindingKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FindingKey

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for FindingKey

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

Formats the value using the given formatter.

impl Eq for FindingKey

impl Ord for FindingKey

fn cmp(&self, other: &FindingKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FindingKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FindingKey

fn partial_cmp(&self, other: &FindingKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for FindingKey

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FindingKey