star_frame 0.30.0

A high performance Solana framework for building fast, scalable, and secure smart contracts.
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

//! Alignment to 1 byte. Much of the [`crate::unsize`] magic relies on packed alignment and no padding.

use solana_pubkey::Pubkey;
pub use star_frame_proc::Align1;
use std::{
    marker::PhantomData,
    num::{NonZeroI8, NonZeroU8},
};

/// A marker trait for types that are guaranteed to be aligned to 1 byte. The [unsized type system](crate::unsize) relies on `Align1` types for its pointer manipulation.
///
/// # Safety
/// This trait should only be implemented for types that are guaranteed to be aligned to 1 byte.
/// The [`Align1`](star_frame_proc::Align1) macro can be used to safely implement this trait for non-generic types.
pub unsafe trait Align1 {}

macro_rules! impl_align1 {
    ($($name:ty),*) => {
        $(
            // SAFETY:
            // Allowed due to the lower assert.
            unsafe impl $crate::align1::Align1 for $name {}
            $crate::static_assertions::assert_eq_align!($name, u8);
        )*
    };
}

impl_align1!((), u8, i8, bool, Pubkey, NonZeroU8, NonZeroI8);

// SAFETY:
// Allowed because `PhantomData` is a ZST.
unsafe impl<T: ?Sized> Align1 for PhantomData<T> {}
// SAFETY:
// Allowed because a slice of `T` is aligned to `T`.
unsafe impl<T> Align1 for [T] where T: Align1 {}
// SAFETY:
// Allowed because an array of `T` is aligned to `T`.
unsafe impl<T, const N: usize> Align1 for [T; N] where T: Align1 {}

macro_rules! impl_align1_tuple {
    ($($name:ident),+) => {
        // SAFETY:
        // Allowed because a tuple will have an alignment equal to the max of its members.
        unsafe impl<$($name),+> Align1 for ($($name,)+)
        where
            $($name: Align1,)+
        {}
    };
}
// impl up to 16 elements
impl_align1_tuple!(T1);
impl_align1_tuple!(T1, T2);
impl_align1_tuple!(T1, T2, T3);
impl_align1_tuple!(T1, T2, T3, T4);
impl_align1_tuple!(T1, T2, T3, T4, T5);
impl_align1_tuple!(T1, T2, T3, T4, T5, T6);
impl_align1_tuple!(T1, T2, T3, T4, T5, T6, T7);
impl_align1_tuple!(T1, T2, T3, T4, T5, T6, T7, T8);
impl_align1_tuple!(T1, T2, T3, T4, T5, T6, T7, T8, T9);
impl_align1_tuple!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10);
impl_align1_tuple!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11);
impl_align1_tuple!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12);
impl_align1_tuple!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13);
impl_align1_tuple!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14);
impl_align1_tuple!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15);
impl_align1_tuple!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16);