8 releases
0.2.1 | Jan 28, 2023 |
---|---|
0.2.0 | Jan 27, 2023 |
0.1.5 | Dec 10, 2022 |
#467 in Debugging
Used in rdbg-client
21KB
388 lines
rdbg
Quick and dirty Rust remote debugging. This crate is more or less equivalent to dbg and println in the stdlib but delivers the payloads via a TCP socket to a remote viewer.
Use Cases
In many cases, for quick debugging the dbg and println macros will often suffice. However, there are three main use cases where this crate comes in handy:
- Tests - while it is possible to output from tests it can be tricky to do so at times
- Programs with no stdout available (example: Windows services, etc.)
- Programs with lots of output, where it is difficult to disambiguate debug output from other output
In all cases, this crate does not replace a regular debugger. If you wish/need to use a full-fledged debugger by all means do so.
Features
- No dependencies
- Enabled and added in seconds
- Familiar API
- Can be quickly be removed or compiled into "no-op"
Example
let world = "world!";
// More or less equivalent to `println`
rdbg::msg!("Hello {}", world);
// More or less equivalent to `dbg`
rdbg::vals!(world, 1 + 1);
That works fine for servers and long-running programs, but since the messages are delivered
via a different thread there is an implicit race condition. As such, if your program
is not a server or long-running you will likely need the flush
function at
the end of your program. This will wait for all queued messages to be sent. For failing tests,
this function will need to be called before the point of crash to see the output.
let world = "world!";
// More or less equivalent to `println`
rdbg::msg!("Hello {}", world);
// More or less equivalent to `dbg`
rdbg::vals!(world, 1 + 1);
// Wait for messages to be transmitted before exiting
rdbg::flush();
Usage
[dependencies]
rdbg = "0.2"
Features
enabled
(default) - enables debugginginsecure-remote
- Listens on 0.0.0.0 for remote debugging purposes (insecure, no auth)
Use --no-default-features
option to quickly turn this crate into a no-op. Please note
that due to feature unification other uses of this crate within the same project could
turn it back on.