Crate dbgflow 

Public facade for the dbgflow graph debugger.

Most users should depend on this crate instead of wiring dbgflow-core and dbgflow-macros manually.

Modules

demo

Demo pipeline and helpers used by the built-in CLI demo.

prelude

Common imports for user code.

runtime

Re-exported runtime and session types from dbgflow-core. Runtime helpers used by generated macros and advanced callers.

Structs

Edge

Re-exported runtime and session types from dbgflow-core. Directed edge between two graph nodes.

Event

Re-exported runtime and session types from dbgflow-core. Single recorded execution event.

FunctionMeta

Re-exported runtime and session types from dbgflow-core. Static metadata generated for traced functions.

Node

Re-exported runtime and session types from dbgflow-core. Graph node metadata persisted in a debugging session.

Session

Re-exported runtime and session types from dbgflow-core. Complete replayable debugging session.

TypeMeta

Re-exported runtime and session types from dbgflow-core. Static metadata generated for #[ui_debug] types.

ValueSlot

Re-exported runtime and session types from dbgflow-core. Named value preview attached to an event.

Enums

EdgeKind

Re-exported runtime and session types from dbgflow-core. Supported edge types in the session graph.

EventKind

Re-exported runtime and session types from dbgflow-core. Supported event kinds emitted by the runtime.

NodeKind

Re-exported runtime and session types from dbgflow-core. Supported node types in the session graph.

Traits

UiDebugValue

Re-exported runtime and session types from dbgflow-core. Trait implemented for values that should appear as UI data nodes.

Functions

capture

Captures a specific block of code into a fresh in-memory session.

capture_and_serve

Captures a specific block of code and immediately serves its session in the browser UI.

capture_session

Re-exported runtime and session types from dbgflow-core. Runs a closure inside a fresh in-memory capture session.

capture_session_and_serve

Re-exported runtime and session types from dbgflow-core. Runs a closure, then serves the captured session over the local UI server.

capture_session_to_path

Re-exported runtime and session types from dbgflow-core. Runs a closure, then writes the captured session to a JSON file.

capture_to_file

Captures a specific block of code and writes its session to a JSON file.

current_session

Re-exported runtime and session types from dbgflow-core. Returns a snapshot of the current in-memory session.

init_session

Starts a fresh in-memory debugging session with the provided title.

load_saved_session

Reads a saved session file, or aggregates all JSON sessions in a directory.

panic_message

Extracts a human-readable panic message from a panic payload.

persist_session_from_env

Persists the current session if the DBG_SESSION_DIR environment variable is set.

read_session_json

Re-exported runtime and session types from dbgflow-core. Reads a session from a JSON file.

reset_session

Re-exported runtime and session types from dbgflow-core. Clears the runtime and starts a new in-memory session.

save_current_session

Writes the current in-memory session to a JSON file.

serve_current_session

Serves the current in-memory session over the embedded local HTTP server.

serve_session

Re-exported runtime and session types from dbgflow-core. Serves a session over the embedded local HTTP server.

serve_session_with_rerun

Re-exported runtime and session types from dbgflow-core. Serves a session over the embedded local HTTP server and exposes a rerun API.

write_session_json

Re-exported runtime and session types from dbgflow-core. Writes the current session to a JSON file.

write_session_snapshot_from_env

Re-exported runtime and session types from dbgflow-core. Writes the current session into the directory pointed to by DBG_SESSION_DIR.

write_session_snapshot_in_dir

Re-exported runtime and session types from dbgflow-core. Writes the current session into a directory using a sanitized file name.

Attribute Macros

dbg_test

Re-exported procedural macros from dbgflow-macros. Wraps a test so it becomes a persisted debugger session.

trace

Re-exported procedural macros from dbgflow-macros. Marks a function as a traced execution node.

ui_debug

Re-exported procedural macros from dbgflow-macros. Marks a struct or enum as a UI-visible data node.