moire-types 1.0.1

Core graph types for moire: entities, events, edges, scopes, and snapshots
Documentation 
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

use facet::Facet;
use moire_trace_types::BacktraceId;

use crate::EntityId;

// r[impl model.edge.fields]
/// Relationship between two entities.
#[derive(Facet)]
pub struct Edge {
    /// Source entity in the causal relationship.
    pub src: EntityId,

    /// Destination entity in the causal relationship.
    pub dst: EntityId,

    /// Backtrace when this edge was created
    pub backtrace: BacktraceId,

    /// Causal edge kind.
    pub kind: EdgeKind,
}

impl Edge {
    /// Builds a causal edge.
    pub fn new(src: EntityId, dst: EntityId, kind: EdgeKind, backtrace: BacktraceId) -> Self {
        Self {
            src,
            dst,
            backtrace,
            kind,
        }
    }
}

// r[impl model.edge.kinds]
#[derive(Facet, Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(u8)]
#[facet(rename_all = "snake_case")]
pub enum EdgeKind {
    /// Poll relationship (task/entity is actively polling another future/resource).
    ///
    /// Example: parent future polls child future during one executor tick.
    Polls,

    /// Waiting relationship (task/entity is blocked on another resource).
    ///
    /// Example: receiver waits on channel `rx.recv().await`.
    WaitingOn,

    /// Pairing relationship between two endpoints that form one logical primitive.
    ///
    /// Example: channel sender paired with its corresponding receiver.
    PairedWith,

    /// Resource ownership/lease relationship (resource -> current holder).
    ///
    /// Example: semaphore is held_by the holder of an acquired permit.
    HeldBy,
}

crate::impl_sqlite_json!(EdgeKind);

crate::declare_edge_kind_slots!(
    PollsEdgeKindSlot::Polls,
    WaitingOnEdgeKindSlot::WaitingOn,
    PairedWithEdgeKindSlot::PairedWith,
    HeldByEdgeKindSlot::HeldBy,
);