hooks-rs 0.2.0

Hooks in Rust for Xahau
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

//! These trace functions are used with XRPL Websocket debug stream.
//!
//! Connect with websocket to `wss://xahau-test.net/debugstream/{r-address}/` or browse to
//! `https://xahau-test.net/debugstream/{r-address}/` to see the debug stream.
//!
//! Your trace logs should appear in the debug stream.

use core::mem::size_of_val;

use crate::c;

use super::*;

/// Write the contents of a buffer to the XRPLD trace log
///
/// # Example
///
/// The first argument will be shown on the left side of the log
/// and the second argument will be shown on the right side of the log.
///
/// Usually you would want to use the first argument to specify what the
/// data is and the second argument to specify the data itself.
/// ```
/// let _ = trace(b"left", b"right", DataRepr::AsUTF8);
/// ```
#[inline(always)]
pub fn trace(msg: &[u8], data: &[u8], data_repr: DataRepr) -> Result<u64> {
    let res = unsafe {
        c::trace(
            msg.as_ptr() as u32,
            size_of_val(msg) as u32,
            data.as_ptr() as u32,
            size_of_val(data) as u32,
            data_repr as _,
        )
    };

    res.into()
}

/// Write the contents of a slot to the XRPLD trace log
#[inline(always)]
pub fn trace_slot(msg: &[u8], slot: u32) -> Result<u64> {
    let res = unsafe { c::trace_slot(msg.as_ptr() as u32, size_of_val(msg) as u32, slot) };

    res.into()
}

/// Write an integer to the XRPLD trace log
///
/// # Example
/// ```
/// let _ = trace_num(b"my number", 42);
/// ```
#[inline(always)]
pub fn trace_num(msg: &[u8], number: i64) -> Result<u64> {
    let res = unsafe { c::trace_num(msg.as_ptr() as u32, size_of_val(msg) as u32, number) };

    res.into()
}

/// Write a XFL float to the XRPLD trace log
///
/// # Example
/// ```
/// let _ = trace_float(b"my float", XFL(42.0));
/// ```
#[inline(always)]
pub fn trace_float(msg: &[u8], float: XFL) -> Result<u64> {
    let res = unsafe { c::trace_float(msg.as_ptr() as u32, size_of_val(msg) as u32, float.0) };

    res.into()
}