ultragraph 0.8.1

Hypergraph data structure.
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82

/*
 * SPDX-License-Identifier: MIT
 * Copyright (c) "2025" . The DeepCausality Authors and Contributors. All Rights Reserved.
 */

use std::fmt;

/// A lightweight, copyable, stack-allocated error type for the next_graph library
/// that provides context about the failure.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum GraphError {
    /// An operation was attempted on a node index that does not exist or has been removed.
    NodeNotFound(usize),

    /// An edge could not be created, typically between two nodes.
    EdgeCreationError { source: usize, target: usize },

    /// An operation was attempted on an edge that does not exist.
    EdgeNotFoundError { source: usize, target: usize },

    /// The operation could not be completed because the graph contains a cycle.
    GraphContainsCycle,

    /// The operation could not be completed because the graph is not frozen.
    GraphNotFrozen,

    /// Operation not possible because the graph is frozen and cannot be mutated.
    GraphIsFrozen,

    /// Root node already exists
    RootNodeAlreadyExists,

    /// Graph algorithm error
    AlgorithmError(&'static str),
}

impl fmt::Display for GraphError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::NodeNotFound(index) => {
                write!(
                    f,
                    "Node with index {index} not found; it may be out of bounds or have been removed."
                )
            }
            Self::EdgeCreationError { source, target } => {
                write!(
                    f,
                    "Edge from {source} to {target} could not be created; a node may not exist or the edge already exists."
                )
            }
            Self::EdgeNotFoundError { source, target } => {
                write!(f, "Edge from {source} to {target} not found.")
            }
            Self::GraphContainsCycle => {
                write!(f, "Operation failed because the graph contains a cycle.")
            }
            Self::GraphNotFrozen => {
                write!(
                    f,
                    "Operation not possible because the graph is not frozen. Call graph.freeze() first."
                )
            }
            Self::GraphIsFrozen => {
                write!(
                    f,
                    "Operation not possible because the graph is frozen and cannot be mutated. Call graph.unfreeze() first."
                )
            }
            Self::RootNodeAlreadyExists => {
                write!(f, "Root node already exists")
            }

            Self::AlgorithmError(e) => {
                write!(f, "AlgorithmError: {e}")
            }
        }
    }
}

// This makes GraphError a fully-fledged error type compatible with the Rust ecosystem.
impl std::error::Error for GraphError {}