fuchsia_inspect_contrib/graph/
mod.rs

1// Copyright 2024 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4//! # Inspect Graph
5//!
6//! This module provides an abstraction over a Directed Graph on Inspect.
7//!
8//! The graph has vertices and edges. Edges have an origin and destination vertex.
9//! Each vertex and edge can have a set of key value pairs of associated metadata.
10//!
11//! The resulting graph has the following schema:
12//!
13//! {
14//!     "fuchsia.inspect.Graph": {
15//!         "topology": {
16//!             "vertex-0": {
17//!                 "meta": {
18//!                     "key-1": value,
19//!                     ...
20//!                     "key-i": value
21//!                 },
22//!                 "relationships": {
23//!                     "vertex-j": {
24//!                         "meta": {
25//!                             "key-1": value,
26//!                             ...
27//!                             "key-i": value
28//!                         }
29//!                     },
30//!                     ...
31//!                     "vertex-k": {
32//!                         "meta": { ... },
33//!                     },
34//!                 }
35//!             },
36//!             ...
37//!             "vertex-i": {
38//!                 "meta": { ...  },
39//!                 "relationships": { ... },
40//!             }
41//!         }
42//!     }
43//! }
44//!
45//! The `topology` node contains all the vertices as children, each of the child names is the ID
46//! of the vertex provided through the API.
47//!
48//! Each vertex has a metadata associated with it under the child `meta`. Each of the child names
49//! of meta is the key of the metadata field.
50//!
51//! Each vertex also has a child `relationships` which contains all the outgoing edges of that
52//! vertex. Each edge is identified by an incremental ID assigned at runtime and contains a property
53//! `@to` which represents the vertex that has that incoming edge. Similar to vertices, it also
54//! has a `meta` containing metadata key value pairs.
55//!
56//! ## Semantics
57//!
58//! This API follows regular inspect semantics with the following important detail: Dropping a
59//! Vertex results in the deletion of all the associated metadata as well as all the associated
60//! outgoing and incoming edges from the Inspect VMO. This is especially important for Edges
61//! given that the program may still be holding an Edge struct, but if any of the nodes associated
62//! with that edge is dropped, the Edge data will be considered as removed from the Inspect VMO and
63//! operations on the Edge will be no-ops.
64//!
65//! ## Overview of type structure
66//!
67//! GraphMetadata is the key-value storage per inspect Node; the value's type is MetadataProperty.
68//! VertexGraphMetadata and EdgeGraphMetadata each contain a field, inner, of type GraphMetadata.
69//!
70//! Metadata is used as input specification but not storage. It holds key and value;
71//! the value is an InnerMetadata enum with internal types MetadataValue and boolean, or Nested.
72
73mod digraph;
74mod edge;
75mod types;
76mod vertex;
77
78pub use digraph::{Digraph, DigraphOpts};
79pub use edge::{Edge, EdgeMetadata};
80pub use types::VertexId;
81pub use vertex::{Vertex, VertexMetadata};
fuchsia_inspect_contrib/graph/mod.rs

fuchsia_inspect_contrib/graph/
mod.rs
