quo-rust 0.1.9

Companion package for the Quo debugger.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

mod info;
pub mod macros;
mod request;
mod tests;
mod types;

use crate::info::hash::get_hash;
use crate::info::runtime::get_runtime;
use crate::info::stack_trace::get_stack_trace;
use crate::info::system_usage::get_system_usage;
use crate::info::thread::get_thread_id;
use crate::info::time::get_time;
use crate::request::make_request;
use crate::types::{QuoContext, QuoPayload, QuoPayloadLanguage, QuoPayloadMeta, QuoPayloadVariable};
pub use crate::types::QuoContext as __private_QuoContext;
use std::fmt::Debug;

/// This fn creates a QuoPayload. You might or might not question why this is a separate function: for testing.
///
/// # Example
///
/// let mut big_number: i128;
///
/// big_number = 170141183460469231731687303715884105727;
///
/// quo_create_payload(&big_number, "big_number", QuoContext { line: line!(), file: file!(), is_mutable: false, is_expression: false, package_name: "quo-rust", shared_grouping_hash: None });
///
#[cfg(debug_assertions)]
#[doc(hidden)]
fn quo_create_payload<T: Debug>(value: T, name: &str, ctx: QuoContext<'_>) -> QuoPayload {
    let id = 0; // @TODO Pretty useless currently.
    let var_type_raw = std::any::type_name_of_val(&value).to_string();
    let var_type = var_type_raw
        .strip_prefix('&')
        .unwrap_or(&var_type_raw)
        .to_string();

    let value_str = format!("{:?}", value);
    let (time_epoch_ms, uid) = get_time();
    let memory_address = Some(format!("{:p}", &value as *const T));
    let grouping_hash = ctx.shared_grouping_hash.or_else(|| get_hash(&var_type_raw, name, ctx.package_name));
    let (stack_trace, caller_function) = get_stack_trace();
    let thread_info = get_thread_id();
    let (cpu_usage, memory_usage) = get_system_usage();
    let runtime = get_runtime();

    QuoPayload {
        language: QuoPayloadLanguage::Rust,
        meta: QuoPayloadMeta {
            origin: ctx.package_name.to_string(),
            sender_origin: format!("{}:{}", ctx.file, ctx.line),
            variable: QuoPayloadVariable {
                var_type: var_type.clone(),
                name: name.to_string(),
                value: value_str,
                is_constant: name == name.to_uppercase(),
                is_mutable: ctx.is_mutable || var_type_raw.contains("&mut "),
                is_expression: ctx.is_expression,
                memory_address,
                grouping_hash,
            },
            id,
            uid,
            time_epoch_ms,
            stack_trace,
            thread_info,
            runtime,
            cpu_usage,
            memory_usage,
            caller_function,
        },
    }
}

/// This fn sends the provided variable to Quo.
///
/// # Example
///
/// let mut big_number: i128;
///
/// big_number = 170141183460469231731687303715884105727;
///
/// quo(&big_number, "big_number", QuoContext { line: line!(), file: file!(), is_mutable: false, is_expression: false, package_name: "quo-rust", shared_grouping_hash: None });
///
#[cfg(debug_assertions)]
#[doc(hidden)]
fn quo<T: Debug>(value: T, name: &str, ctx: QuoContext<'_>) {
    #[cfg(debug_assertions)]
    {
        let env_host = option_env!("QUO_HOST").unwrap_or("http://127.0.0.1");
        let env_port = option_env!("QUO_PORT").unwrap_or("7312");

        let body = quo_create_payload(value, name, ctx);
        let quo_server_address = format!("{}:{}/payload", env_host, env_port);

        make_request(&quo_server_address, body);
    }
}

/// Use the `quo!()` macro and not this fn directly.
#[cfg(debug_assertions)]
#[doc(hidden)]
pub fn __private_quo_grouping_hash(args_key: &str, package_name: &str) -> Option<String> {
    get_hash("grouped", args_key, package_name)
}

/// Use the `quo!()` macro and not this fn directly.
#[cfg(debug_assertions)]
#[doc(hidden)]
pub fn __private_quo<T: Debug>(value: T, name: &str, ctx: QuoContext<'_>) {
    quo(value, name, ctx)
}