fre_rs/
lib.rs

1//!
2//! Safe, ergonomic Rust abstraction over the AIR Native Extension (ANE) C API ([`fre-sys`](https://crates.io/crates/fre-sys)) for native-side development.
3//!
4//! ## Getting Started
5//!
6//! The primary entry points of this crate are the macros [`extension!`] and [`function!`].
7//! Refer to their documentation for details and examples.
8//!
9//! # Flash Runtime Extension Lifecycle
10//!
11//! ```text
12//!                                   Flash-Runtime ━━━━┓
13//!                                                     ┃
14//!          ExtensionContext.loadExtension ━━━━━━━━━━━━┫
15//!                ↓                                    ┃
16//!    ┏━━━━ Extension-Load ━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
17//!    ┃           ↓                                    ┃
18//!    ┃     Initializer → Extension-Data               ┃
19//!    ┃           ↓                                    ┃
20//!    ┃  ┏━━ ExtensionContext.createExtensionContext ━━┫
21//!    ┃  ┃        ↓                                    ┃
22//!    ┃  ┃    Context-Initializer → Context-Data       ┃
23//!    ┃  ┃        ↓            ↓    ↓         ↓        ┃
24//!    ┃  ┃    Function-Data → Function  Extension-Data ┃
25//!    ┃  ┃                     ↑                       ┃
26//!    ┃  ┣━━ ExtensionContext.call ━━━━━━━━━━━━━━━━━━━━┫
27//!    ┃  ┃                                             ┃
28//!    ┃  ┃                        Extension-Data       ┃
29//!    ┃  ┃                              ↑              ┃
30//!    ┃  ┃    Context-Data ≈ `ContextRegistry`         ┃
31//!    ┃  ┃        ↓                     ↑              ┃
32//!    ┃  ┃    Context-Finalizer    Function-Data       ┃
33//!    ┃  ┃        ↑                                    ┃
34//!    ┃  ┗━━ ExtensionContext.dispose ━━━━━━━━━━━━━━━━━┫
35//!    ┃                                                ┃
36//!    ┃            Extension-Data → Finalizer          ┃
37//!    ┃                                 ↑              ┃
38//!    ┗━━━━━━━━━━━━━━━━━━━━━━━━━━ Extension-Unload ━━━━┛
39//! ```
40//!
41
42
43
44/// Namespace for ActionScript 3 object types.
45/// 
46pub mod as3 {
47    use super::*;
48    pub use crate::types::{
49        classes::{Array, Vector, ByteArray, BitmapData, Context3D, ErrorObject as Error},
50        object::{Object},
51        primitive::{int, uint, Number, Boolean, StringObject as String}
52    };
53
54    /// Although `'static`, it must not be used outside the Flash runtime main thread,
55    /// or related APIs may return errors or panic due to failed assertions.
56    #[allow(non_upper_case_globals)]
57    pub const null: Object = unsafe {transmute(std::ptr::null_mut::<FREObject>())};
58}
59/// [`fre-sys`](https://crates.io/crates/fre-sys)
60pub mod c {pub use fre_sys::*;}
61pub mod prelude {
62    pub use crate::{
63        as3,
64        types::{Type, object::{AsObject, TryAs}},
65        context::{Context, CurrentContext},
66        data::Data,
67        event::*,
68        function::FunctionSet,
69        validated::*,
70    };
71    pub use std::any::Any;
72}
73pub mod context;
74pub mod data;
75pub mod error;
76pub mod event;
77pub mod function;
78mod macros;
79pub mod misc;
80pub mod types;
81pub mod validated;
82pub mod utils;
83pub mod _internal;
84
85use {
86    prelude::*,
87    c::prelude::*,
88    data::ExtensionData,
89    error::*,
90    function::*,
91    utils::*,
92    _internal::Sealed,
93};
94use std::{
95    cell::{RefCell},
96    collections::HashMap,
97    error::Error,
98    ffi::{CStr, CString, NulError, c_void, c_char},
99    fmt::{self, Debug, Display},
100    marker::PhantomData,
101    mem::{transmute, size_of, size_of_val},
102    ptr::{NonNull},
103    str::Utf8Error,
104    sync::{Arc, Mutex},
105};
fre_rs/lib.rs

fre_rs/
lib.rs
