firedbg_protocol/lib.rs
1//! ## FireDBG Event Stream Protocol
2//!
3//! The FireDBG Event Stream is serialized according to the SeaStreamer File Format, which by convention has the `.ss` extension.
4//! The Protocol defines the different streams and formats of the messages on top of the file format, and thus they have the `.firedbg.ss` extension.
5//! The file format is not tightly-coupled with the stream protocol, as it is possible to stream to/from a different backend, e.g. Redis.
6//!
7//! There are currently 4 streams:
8//!
9//! | Stream Key | Format | Description |
10//! |:----------:|:------:|:-----------:|
11//! | `info` | Json | DebuggerInfo: debugger version, debug target, arguments and exit code, etc |
12//! | `file` | Json | SourceFile: relative path to the source file |
13//! | `breakpoint` | Json | Breakpoint: breakpoints created and the source location |
14//! | `event` | Binary | Event: function call, function return, etc |
15pub use indexmap::IndexMap;
16
17pub mod breakpoint;
18pub mod event;
19pub mod info;
20pub mod source;
21mod util;
22pub mod value;