Struct Edge 

pub struct Edge {
    pub src: String,
    pub dst: String,
    pub kind: EdgeKind,
    pub provenance: Provenance,
    pub confidence: Option<f64>,
    pub src_ref: Option<String>,
}

An edge in the knowledge graph, connecting two nodes by their keys.

The Provenance invariant is enforced on insert: confidence is present if and only if the provenance is Provenance::Inferred.

Fields

src: String

Natural key of the source node.

dst: String

Natural key of the destination node.

kind: EdgeKind

The relationship this edge records.

provenance: Provenance

How this edge was produced.

confidence: Option<f64>

Confidence score in 0.0..=1.0; Some iff provenance is inferred.

src_ref: Option<String>

Where the fact came from (e.g. blob#span, or an ADR id).

Implementations

impl Edge

pub fn derived( src: impl Into<String>, dst: impl Into<String>, kind: EdgeKind, ) -> Self

Construct a derived edge (no confidence).

pub fn authored( src: impl Into<String>, dst: impl Into<String>, kind: EdgeKind, ) -> Self

Construct an authored edge (no confidence).

pub fn inferred( src: impl Into<String>, dst: impl Into<String>, kind: EdgeKind, confidence: f64, ) -> Self

Construct an inferred edge carrying a confidence score.

pub fn is_valid(&self) -> bool

Whether this edge is valid for storage: a confidence score is present exactly when the edge is inferred, and any present score is a finite value in 0.0..=1.0 (rejecting NaN, infinities, and out-of-range).

Trait Implementations

impl Clone for Edge

fn clone(&self) -> Edge

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Edge

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Edge

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Edge

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Edge

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 Edge