jiminy-core 0.17.0

Core systems layer for Jiminy: account layout, zero-copy IO, validation, PDA, sysvar access, math, time checks. Declarative macros for error codes, instruction dispatch, and account uniqueness. no_std, no_alloc, no proc macros, BPF-safe.
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

//! Bit-level helpers for account flags and bitmask fields.

use hopper_runtime::ProgramError;

/// Read bit `n` from a byte. Returns `true` if the bit is set.
///
/// Bits are numbered LSB-first: bit 0 is `0x01`, bit 7 is `0x80`.
#[inline(always)]
pub fn read_bit(byte: u8, n: u8) -> bool {
    (byte >> n) & 1 == 1
}

/// Set bit `n` in a byte, returning the modified value.
#[inline(always)]
pub fn set_bit(byte: u8, n: u8) -> u8 {
    byte | (1u8 << n)
}

/// Clear bit `n` in a byte, returning the modified value.
#[inline(always)]
pub fn clear_bit(byte: u8, n: u8) -> u8 {
    byte & !(1u8 << n)
}

/// Toggle bit `n` in a byte, returning the modified value.
#[inline(always)]
pub fn toggle_bit(byte: u8, n: u8) -> u8 {
    byte ^ (1u8 << n)
}

/// Return `true` if ALL bits in `mask` are set in `byte`.
#[inline(always)]
pub fn check_flags(byte: u8, mask: u8) -> bool {
    byte & mask == mask
}

/// Return `true` if ANY bit in `mask` is set in `byte`.
#[inline(always)]
pub fn check_any_flag(byte: u8, mask: u8) -> bool {
    byte & mask != 0
}

/// Read the `flags` byte from a data slice at `offset`.
#[inline(always)]
pub fn read_flags_at(data: &[u8], offset: usize) -> Result<u8, ProgramError> {
    data.get(offset)
        .copied()
        .ok_or(ProgramError::AccountDataTooSmall)
}

/// Write `value` to the flags byte at `offset` in a mutable data slice.
#[inline(always)]
pub fn write_flags_at(data: &mut [u8], offset: usize, value: u8) -> Result<(), ProgramError> {
    let byte = data
        .get_mut(offset)
        .ok_or(ProgramError::AccountDataTooSmall)?;
    *byte = value;
    Ok(())
}