magic-space 0.1.0

Like anchor's InitSpace but without the dependency on anchor.
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

# Magic Space

![Logo](./images/stars.jpg) ~Yes, It's AI generated.~

[![Crates.io](https://img.shields.io/crates/v/magic-space.svg)](https://crates.io/crates/magic-space)
[![Docs.rs](https://docs.rs/magic-space/badge.svg)](https://docs.rs/magic-space)
[![License](https://img.shields.io/crates/l/magic-space.svg)](

Derive macro for Solana program state structs that automatically calculates the space required for the struct.

Code mostly taken from `@coral-xyz/anchor` project, modified to work without the anchor crate.

Source:

- https://github.com/coral-xyz/anchor/blob/master/lang/derive/space/src/lib.rs

## Installation

Add the following to your `Cargo.toml`:

```toml
[dependencies]
magic_space = "^0.1.0"
```

Or cargo add:

```sh
$ cargo add magic-space
```

## Usage

```rust
use magic_space::*;

#[derive(MagicSpace)]
struct SomeAccount {
    apples: u32,
    oranges: u32,
    #[max_len(10)]
    others: Vec<u32>,
    #[max_len(10)]
    name: String,
    #[max_len(10, 5, 5)]
    some_other: Vec<Vec<Vec<u8>>>,
    #[max_len(10)]
    e: Vec<Option<SomeEnum>>,
}
```

If you have dynamic allocation, you can still use the max_len attribute as follows: `#[max_len(0)]` and avoid worrying about the vector length, that way you can apply the following pattern:

```rust
#[derive(MagicSpace)]
pub struct DynamicSizeVecPattern {
    #[max_len(0)]
    pub data: Vec<Item>,
}

impl DynamicSizeVecPattern {
    pub fn size(vec_len: usize, str_len: usize) -> usize {
        Self::MAGIC_SPACE + (vec_len * Item::size(str_len))
    }
}

#[derive(MagicSpace)]
pub struct Item {
    pub data: u64,
    #[max_len(0)]
    pub name: String,
}
```

## License

Apache 2.0 [LICENSE](LICENSE)