dylink 0.5.0

Run-time dynamic linking loader utilities
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

# Dylink


![Crates.io](https://img.shields.io/crates/l/dylink) ![Crates.io](https://img.shields.io/crates/v/dylink) ![Crates.io](https://img.shields.io/crates/d/dylink) ![docs.rs](https://img.shields.io/docsrs/dylink) ![unsafe:yes](https://img.shields.io/badge/unsafe-yes-red)

Dylink provides a run-time dynamic linking framework for lazily evaluating shared libraries such as `.dll` files for windows
and `.so` files for unix. When functions are loaded they are evaluated through a thunk for first time calls, which loads the
function from it's respective library. Proceeding calls after initialization have no overhead or additional branching checks,
as the thunk is replaced by the loaded function.

----

Related links:

* [API Documentation](https://docs.rs/dylink)
* [Release notes](https://github.com/Razordor/dylink/releases)

## Supported platforms


Dylink has been implemented for all major platforms aside from WASM, but has only been locally tested on Windows and Linux.

| Win64 | Linux | MacOS    | Unix(other) | WASM |
|:-----:|:-----:|:--------:|:-----------:|------|
| YES   | YES   | Untested | Untested    | NO   |

## Usage


Add this to your `Cargo.toml`

```toml
[dependencies]
dylink = "0.5"
```

## Example


Below is a basic working example on how to use the macro on windows.
For windows, the `.dll` file extension is *optional*, but still recommended.

```rust
use dylink::dylink;

#[dylink(name = "Kernel32.dll")]

extern "stdcall" {
    fn GetLastError() -> u32;
    fn SetLastError(_: u32);
}

fn main() {
   unsafe {
      SetLastError(52);
      assert_eq!(52, GetLastError());
   }
}
```

### License


Licensed under either of

* Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
* MIT license
   ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)

at your option.

### Contribution


Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.