1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
//! # A struct representing an edge in the graph.
//!
//! Contains an [EdgeID] which is a key to the edge in the slotmap, and two [NodeID]s which are the nodes the edge connects (from & to).
//!
//! An edge can also have “data”, which could be anything or nothing; for example the weight of the connection or a struct or enum representing something else.
//!
//! # Why is there no "EdgeTrait"?
//!
//! The [Edge] struct is very simple and doesn't need a trait. It's just a struct with an ID, two node IDs, and some data.
//! If you want to add more functionality or data to the edge you can probably just add it to the data field, or add an edge as a field to your custom type.
use slotmap::{new_key_type, KeyData};
use super::*;
new_key_type! {
/// An index to an edge in the slotmap
pub struct EdgeID;
}
impl EdgeID {
pub fn to_u64(&self) -> u64 {
self.0.as_ffi()
}
pub fn from_u64(id: u64) -> Self {
EdgeID::from(KeyData::from_ffi(id))
}
}
/// # A struct representing an edge in the graph.
///
/// Contains an [EdgeID] which is a key to the edge in the slotmap, and two [NodeID]s which are the nodes the edge connects (from & to).
/// An edge can also have “data”, which could be anything or nothing; for example the weight of the connection or a struct or enum representing something else.
///
/// ## Why is there no "EdgeTrait"?
///
/// The [Edge] struct is very simple and doesn't need a trait. It's just a struct with an ID, two node IDs, and some data.
/// If you want to add more functionality or data to the edge you can probably just add it to the data field, or add an edge as a field to your custom type.
#[derive(Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "specta", derive(specta::Type))]
pub struct Edge<T: Clone> {
pub id: EdgeID,
pub from: NodeID,
pub to: NodeID,
pub data: T,
}
/// Implements Hash for Edge<T> so only the ID is used for hashing.
impl<T: std::hash::Hash> std::hash::Hash for Edge<T>
where
T: Clone,
{
fn hash<H: std::hash::Hasher>(&self, ra_expand_state: &mut H) {
self.id.hash(ra_expand_state);
}
}
/// Implements PartialEq for Edge<T> so only the ID is used for comparison.
impl<T: Clone> PartialEq for Edge<T> {
fn eq(&self, other: &Self) -> bool {
self.id == other.id
}
}
impl<T: Clone + fmt::Debug> fmt::Debug for Edge<T> {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(
f,
"Edge {{ id: {:#?}, from: {:#?}, to: {:#?}, data: {:#?} }}",
self.id, self.from, self.to, self.data
)
}
}
impl<T: Clone> Edge<T> {
pub fn new(id: EdgeID, from: NodeID, to: NodeID, data: T) -> Edge<T> {
Edge { id, from, to, data }
}
}
#[cfg(feature = "specta")]
const _: () = {
const SID: specta::SpectaID = specta::internal::construct::sid(
"EdgeID",
concat!("::", module_path!(), ":", line!(), ":", column!()),
);
const IMPL_LOCATION: specta::ImplLocation =
specta::internal::construct::impl_location(concat!(file!(), ":", line!(), ":", column!()));
const DEFINITION_GENERICS: &[specta::DataType] = &[];
#[automatically_derived]
impl specta::Type for EdgeID {
fn inline(
type_map: &mut specta::TypeMap,
generics: &[specta::DataType],
) -> specta::DataType {
specta::DataType::Struct(specta::internal::construct::r#struct(
"EdgeID".into(),
Some(SID),
vec![],
specta::internal::construct::struct_named(
vec![
(
"idx".into(),
specta::internal::construct::field(
false,
false,
None,
"".into(),
Some({
let ty = <u32 as specta::Type>::reference(type_map, &[]).inner;
ty
}),
),
),
(
"version".into(),
specta::internal::construct::field(
false,
false,
None,
"".into(),
Some({
let ty = <u32 as specta::Type>::reference(type_map, &[]).inner;
ty
}),
),
),
],
None,
),
))
}
fn definition(type_map: &mut specta::TypeMap) -> specta::DataType {
Self::inline(type_map, &DEFINITION_GENERICS)
}
fn reference(
type_map: &mut specta::TypeMap,
generics: &[specta::DataType],
) -> specta::reference::Reference {
{
let generics: &[specta::DataType] = &[];
specta::reference::reference::<Self>(
type_map,
specta::internal::construct::data_type_reference("EdgeID".into(), SID, vec![]),
)
}
}
}
#[automatically_derived]
impl specta::NamedType for EdgeID {
const SID: specta::SpectaID = SID;
const IMPL_LOCATION: specta::ImplLocation = IMPL_LOCATION;
fn named_data_type(
type_map: &mut specta::TypeMap,
generics: &[specta::DataType],
) -> specta::NamedDataType {
specta::internal::construct::named_data_type(
"EdgeID".into(),
"".into(),
None,
SID,
IMPL_LOCATION,
<Self as specta::Type>::inline(type_map, generics),
)
}
fn definition_named_data_type(type_map: &mut specta::TypeMap) -> specta::NamedDataType {
specta::internal::construct::named_data_type(
"EdgeID".into(),
"".into(),
None,
SID,
IMPL_LOCATION,
<Self as specta::Type>::definition(type_map),
)
}
}
#[automatically_derived]
impl specta::Flatten for EdgeID {}
};