Struct Edge 

pub struct Edge {
    pub id: EdgeId,
    pub src: NodeId,
    pub dst: NodeId,
    pub edge_type: Arc<str>,
    pub properties: BTreeMap<PropertyKey, Value>,
}

A relationship between two nodes, with a type and optional properties.

Think of edges as the “verbs” in your graph - KNOWS, WORKS_AT, PURCHASED. Each edge connects exactly one source node to one destination node.

Example

use grafeo_core::graph::lpg::Edge;
use grafeo_common::types::{EdgeId, NodeId};

let mut works_at = Edge::new(
    EdgeId::new(1),
    NodeId::new(10),  // Alice
    NodeId::new(20),  // Acme Corp
    "WORKS_AT"
);
works_at.set_property("since", 2020i64);
works_at.set_property("role", "Engineer");

Fields

id: EdgeId

Unique identifier.

src: NodeId

Source node ID.

dst: NodeId

Destination node ID.

edge_type: Arc<str>

Edge type/label.

properties: BTreeMap<PropertyKey, Value>

Properties stored on this edge.

Implementations

impl Edge

pub fn new( id: EdgeId, src: NodeId, dst: NodeId, edge_type: impl Into<Arc<str>>, ) -> Self

Creates a new edge.

pub fn set_property( &mut self, key: impl Into<PropertyKey>, value: impl Into<Value>, )

Sets a property on this edge.

pub fn get_property(&self, key: &str) -> Option<&Value>

Gets a property from this edge.

pub fn remove_property(&mut self, key: &str) -> Option<Value>

Removes a property from this edge.

pub fn other_endpoint(&self, node: NodeId) -> Option<NodeId>

Given one endpoint, returns the other end of this edge.

Handy in traversals when you have a node and edge but need the neighbor. Returns None if node isn’t connected to this edge.

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.