solana-program-log 1.2.0

Lightweight log utility for Solana programs
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

//! Logging wrapper for Solana syscalls.

#[cfg(not(any(target_os = "solana", target_arch = "bpf")))]
use core::hint::black_box;
#[cfg(any(target_os = "solana", target_arch = "bpf"))]
use solana_define_syscall::definitions::{
    sol_log_, sol_log_64_, sol_log_compute_units_, sol_log_data,
};

/// Print a string to the log.
#[inline(always)]
pub fn log(message: &str) {
    #[cfg(any(target_os = "solana", target_arch = "bpf"))]
    unsafe {
        sol_log_(message.as_ptr(), message.len() as u64);
    }

    #[cfg(not(any(target_os = "solana", target_arch = "bpf")))]
    black_box(message);
}

/// Print 64-bit values represented as hexadecimal to the log.
#[inline(always)]
pub fn log_64(arg1: u64, arg2: u64, arg3: u64, arg4: u64, arg5: u64) {
    #[cfg(any(target_os = "solana", target_arch = "bpf"))]
    unsafe {
        sol_log_64_(arg1, arg2, arg3, arg4, arg5);
    }

    #[cfg(not(any(target_os = "solana", target_arch = "bpf")))]
    black_box((arg1, arg2, arg3, arg4, arg5));
}

/// Print some slices as `base64`.
#[inline(always)]
pub fn log_data(data: &[&[u8]]) {
    #[cfg(any(target_os = "solana", target_arch = "bpf"))]
    unsafe {
        sol_log_data(data as *const _ as *const u8, data.len() as u64)
    };

    #[cfg(not(any(target_os = "solana", target_arch = "bpf")))]
    black_box(data);
}

/// Print the remaining compute units available to the program.
#[inline]
pub fn log_compute_units() {
    #[cfg(any(target_os = "solana", target_arch = "bpf"))]
    unsafe {
        sol_log_compute_units_();
    }
}