fre-rs 0.1.0

Safe, ergonomic Rust abstraction over the AIR Native Extension (ANE) C API (`fre-sys`) for native-side development.
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

# [`fre-rs`](https://crates.io/crates/fre-rs)


Safe, ergonomic Rust abstraction over the AIR Native Extension (ANE) C API ([`fre-sys`](https://crates.io/crates/fre-sys)) for native-side development.

This crate depends on the AIR SDK via [`fre-sys`](https://crates.io/crates/fre-sys). See its documentation for setup instructions.

## References


- [Adobe AIR SDK from HARMAN](https://airsdk.harman.com)
- [AIR | AIR SDK](https://airsdk.dev/docs)
- [ActionScript 3.0 Language Reference](https://airsdk.dev/reference/actionscript/3.0)
- [Adobe Flash Platform * Developing Native Extensions for AdobeAIR](https://help.adobe.com/en_US/air/extensions/index.html)
- [Adobe ActionScript® 3 (AS3) API Reference](https://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/index.html)

## Safety


This crate provides safe abstractions over the ANE C API.

Underlying objects may still be modified externally by the AIR runtime.

Unsafe code is minimized and encapsulated, but correct usage of this crate's API is still required.

## License


MIT OR Apache-2.0

## Getting Started


The primary entry points of this crate are the macros [`extension!`] and [`function!`].

Refer to their documentation for details and examples.

## Example


```rust
use fre_rs::prelude::*;
fre_rs::extension! {
    extern symbol_initializer;
    gen context_initializer, final;
}
fn context_initializer(frt: &FlashRuntime) -> FunctionSet {
    let mut funcs = FunctionSet::new();
    funcs.add(None, None::<()>, method_name);
    funcs
}
fre_rs::function! {
    method_name (frt, _, args) -> StringObject {
        frt.trace(args);
        StringObject::new(frt, "Hello! Flash Runtime")
    }
}
```