fre-rs 0.3.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
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

//!
//! Safe, ergonomic Rust abstraction over the AIR Native Extension (ANE) C API ([`fre-sys`](https://crates.io/crates/fre-sys)) for native-side development.
//!
//! ## Getting Started
//!
//! The primary entry points of this crate are the macros [`extension!`] and [`function!`].
//! Refer to their documentation for details and examples.
//!
//! # Flash Runtime Extension Lifecycle
//!
//! ```text
//!                                   Flash-runtime ━━━━┓
//!                                                     ┃
//!          ExtensionContext.loadExtension ━━━━━━━━━━━━┫
//!                ↓                                    ┃
//!    ┏━━━━ Extension-Load ━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
//!    ┃           ↓                                    ┃
//!    ┃     Initializer → Extension-Data               ┃
//!    ┃           ↓                                    ┃
//!    ┃  ┏━━ ExtensionContext.createExtensionContext ━━┫
//!    ┃  ┃        ↓                                    ┃
//!    ┃  ┃    Context-Initializer → Context-Data       ┃
//!    ┃  ┃        ↓            ↓    ↓         ↓        ┃
//!    ┃  ┃    Function-Data → Function  Extension-Data ┃
//!    ┃  ┃                     ↑                       ┃
//!    ┃  ┣━━ ExtensionContext.call ━━━━━━━━━━━━━━━━━━━━┫
//!    ┃  ┃                                             ┃
//!    ┃  ┃                        Extension-Data       ┃
//!    ┃  ┃                              ↑              ┃
//!    ┃  ┃    Context-Data ≈ `ContextRegistry`         ┃
//!    ┃  ┃        ↓                     ↑              ┃
//!    ┃  ┃    Context-Finalizer    Function-Data       ┃
//!    ┃  ┃        ↑                                    ┃
//!    ┃  ┗━━ ExtensionContext.dispose ━━━━━━━━━━━━━━━━━┫
//!    ┃                                                ┃
//!    ┃            Extension-Data → Finalizer          ┃
//!    ┃                                 ↑              ┃
//!    ┗━━━━━━━━━━━━━━━━━━━━━━━━━━ Extension-Unload ━━━━┛
//! ```
//!



/// Namespace for ActionScript 3 classes and objects.
/// 
pub mod as3 {
    use super::*;
    pub use crate::types::{
        display::*,
        misc::*,
        object::{Object},
        primitive::*,
    };

    /// Although `'static`, using [`null`] outside the Flash runtime main thread,
    /// or within certain restricted closure call stacks (when an object is acquired
    /// and the runtime is constrained) is unsupported. Related APIs may return errors in such cases.
    /// 
    #[allow(non_upper_case_globals)]
    // 
    // ALL APIS THAT MAY BE USED IN UNSUPPORTED CASES MUST HANDLE ERRORS CORRECTLY AND MUST NOT PANIC. (`AsObject`, `Object`)
    // 
    pub const null: Object<'static> = unsafe {transmute(std::ptr::null_mut::<FREObject>())};
}

/// [`fre-sys`](https://crates.io/crates/fre-sys)
/// 
pub mod c {pub use fre_sys::*;}
pub mod prelude {
    pub use crate::{
        as3,
        types::{Type, object::{Object, NonNullObject, AsObject, AsNonNullObject, TryAs}},
        context::{Context, CurrentContext},
        data::Data,
        event::*,
        function::{FunctionSet, trace},
        validated::*,
    };
    pub use std::any::Any;
}
pub mod context;
pub mod data;
pub mod error;
pub mod event;
pub mod function;
mod macros;
pub mod misc;
pub mod types;
pub mod validated;
pub mod utils;


use {
    prelude::*,
    c::*,
    data::ExtensionData,
    error::*,
    function::*,
    misc::*,
    utils::*,
};
use std::{
    borrow::Cow,
    cell::{RefCell},
    collections::HashMap,
    ffi::{CStr, CString, NulError, c_void, c_char},
    fmt::{self, Debug, Display},
    marker::PhantomData,
    mem::{MaybeUninit, transmute},
    ptr::{NonNull},
    rc::Rc,
    str::Utf8Error,
    sync::{Arc, Mutex},
};


/// Internal implementation details of the crate. Not intended for public use.
/// 
#[doc(hidden)]
pub mod __private {
    pub unsafe trait Sealed {}
    pub(crate) const SEALED: () = ();
    pub mod context {
        pub use crate::context::stack::{with, with_initializer, with_method};
    }
}