hotcode 0.1.5

Library for hotreload in Rust.
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

# hotcode

Library for hot-reloading functions in Rust.

[![Build Status](https://github.com/alordash/hotcode/actions/workflows/ci.yml/badge.svg)](https://github.com/alordash/hotcode/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/hotcode.svg)](https://crates.io/crates/hotcode)
[![Documentation](https://docs.rs/hotcode/badge.svg)](https://docs.rs/hotcode)

## Overview

This library exposes `hotreload` attribute, which can be applied to standalone functions or to functions in `impl`
blocks. This attribute makes a function hot-reloadable: its code and behavior can be changed on the fly while the
application is still running.

💻 Works on **Linux**, **macOS** and **Windows**.  
🪲 Hot-reloaded code can be debugged.

## Usage

Add `hotcode` to your `dependencies`:

```toml
[dependencies]
hotcode = "0.1.5"
```

Add `cdylib` to your library's crate types:

```toml
[lib]
crate-type = ["cdylib", "lib"]
```

Add `hotcode::hotreload` attribute to your function:

```rust
#[hotcode::hotreload]
fn add(a: i32, b: i32) -> i32 {
    a + b
}
```

Run your application, change the code of this function and rebuild your library using `cargo build --lib`. The
function's behavior will change without restarting the application.

For more information, refer to [crate documentation](https://docs.rs/hotcode).

## Examples

Examples are located in the [`examples`](examples) folder. The simplest example is the
[`single_crate`](examples/single_crate) project.

## Minimum Supported Rust Version (MSRV)

`hotcode` is supported on Rust 1.89.0 and higher. `hotcode`'s MSRV will not be changed in the future without bumping the
major or minor version.

## License

`hotcode` is distributed under the terms of the MIT license. See [license.txt](license.txt) for details.