quo-rust 0.1.3

Companion package for the Quo debugger.
Documentation

Quo Preview

Quo is a cross-platform variable dumper designed to make debugging easier. It receives data from your application and displays it in a clean desktop interface, allowing you to inspect complex values in real-time without cluttering your terminal or browser console.

Noteworthy features

  • Debug-only: The macro only executes in debug mode (#[cfg(debug_assertions)]). In release builds, it compiles to nothing, ensuring zero overhead.
  • Multiple arguments: Inspect multiple variables in a single call.

Installation

Add quo-rust to your Cargo.toml under dev-dependencies:

[dev-dependencies]

quo-rust = "0.1.2"

Usage

Import the macro and pass variables to inspect:

use quo_rust::quo;

#[derive(Debug)]
struct User {
    id: u32,
    username: String,
}

fn main() {
    let user_id = 42;
    let user = User { id: 1, username: "jdoe".to_string() };
    
    // Dump a single variable
    quo!(user_id);

    // Dump multiple variables at once
    quo!(user_id, user);
}

Configuration

You can customize the Quo server address using environment variables at compile time:

  • QUO_HOST: The host where Quo is running (default: http://127.0.0.1, Quo always listens on 127.0.0.1 so changing this has no use).
  • QUO_PORT: The port Quo is listening on (default: 7312)

The correct port can be found by opening the Quo client in the bottom left.

Note: The Quo client always uses 127.0.0.1 as host, it is not recommended to have it set to any other host.

You can set these in your Cargo.toml as follows

[env]

QUO_HOST="http://127.0.0.1"

QUO_PORT="7312"


License

Quo is open-source software licensed under the GPL-3 license.