rong 0.3.1

RongJS runtime and embedding API
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
128
129
130
131
132

pub use rong_core::err_data;
pub use rong_core::{
    AnyJSTypedArray as CoreAnyJSTypedArray, Class as CoreClass, ClassSetup, FromJSValue, HostError,
    IntoJSAsyncIteratorExt, IntoJSIteratorExt, IntoJSValue, JSArray as CoreJSArray,
    JSArrayBuffer as CoreJSArrayBuffer, JSAsyncIterator, JSBytes as CoreJSBytes, JSClass,
    JSContext as CoreJSContext, JSContextService, JSDate as CoreJSDate, JSEngine,
    JSException as CoreJSException, JSFunc as CoreJSFunc, JSIterator, JSObject as CoreJSObject,
    JSProxy as CoreJSProxy, JSResult, JSRuntime as CoreJSRuntime, JSRuntimeService,
    JSSymbol as CoreJSSymbol, JSTypedArray as CoreJSTypedArray, JSTypedArrayKind,
    JSValue as CoreJSValue, JSValueType, JsonToJSValue, Promise as CorePromise,
    PropertyDescriptor as CorePropertyDescriptor, RongJSError, Source, SourceKind, Uint8Clamped,
    error, illegal_constructor, install_async_iterator_symbol, install_iterator_symbol,
};
// Re-export selected runtime API from rong_core::rong so downstream crates use `rong::...`
pub use rong_core::rong::{
    Rong, RongBuildError, TaskHandle, TaskMessage, Worker, WorkerState, spawn_local,
};
pub use rong_core::{PinnedRong, PinnedSpawnError};

// Re-export user-agent helpers.
pub use rong_rt::sse;
pub use rong_rt::upload;
pub use rong_rt::{
    DEFAULT_USER_AGENT, InstallGlobalExecutorError, RongExecutor, RongExecutorBuildError,
    RongExecutorBuilder, get_user_agent, set_user_agent,
};
// Re-export selected JS invoke queue APIs (module remains internal to core)
pub use rong_core::{JsInvokePriority, enqueue_js_invoke};

pub mod function {
    pub use rong_core::function::{
        Constructor, FromParams, IntoJSCallable, IntoOnceJSCallable, JSParameterType, KAsyncFnMut,
        KAsyncFnOnce, KFnMut, KFnOnce, Optional, ParamsAccessor, Rest, This,
    };

    #[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
    pub type ThisMut<T> = rong_core::function::ThisMut<T, crate::JSEngineValue>;

    #[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
    pub type JSClassRef<T> = rong_core::function::JSClassRef<T, crate::JSEngineValue>;

    #[cfg(not(any(feature = "quickjs", feature = "jscore", feature = "arkjs")))]
    pub type ThisMut<T> = rong_core::function::ThisMut<T, ()>;

    #[cfg(not(any(feature = "quickjs", feature = "jscore", feature = "arkjs")))]
    pub type JSClassRef<T> = rong_core::function::JSClassRef<T, ()>;
}

#[cfg(any(
    all(feature = "quickjs", feature = "jscore"),
    all(feature = "quickjs", feature = "arkjs"),
    all(feature = "jscore", feature = "arkjs"),
))]
compile_error!(
    "`rong` engine features are mutually exclusive: enable exactly one of `quickjs`, `jscore`, or `arkjs`."
);

#[cfg(feature = "quickjs")]
mod engine {
    use rong_quickjs::QuickJS;
    pub type RongJS = QuickJS;
}

#[cfg(all(not(feature = "quickjs"), not(feature = "arkjs"), feature = "jscore"))]
mod engine {
    use rong_jscore::JavaScriptCore;
    pub type RongJS = JavaScriptCore;
}

#[cfg(all(not(feature = "quickjs"), not(feature = "jscore"), feature = "arkjs"))]
mod engine {
    use rong_arkjs::HarmonyArkJS;
    pub type RongJS = HarmonyArkJS;
}

// When no engine is selected, the engine types are not available
// This allows the crate to compile for modules that don't use the engine directly
#[cfg(not(any(feature = "quickjs", feature = "jscore", feature = "arkjs")))]
mod engine {}

#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub use engine::*;

#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSEngineValue = <RongJS as JSEngine>::Value;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSEngineContext = <RongJS as JSEngine>::Context;

#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSContext = CoreJSContext<<RongJS as JSEngine>::Context>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSRuntime = CoreJSRuntime<<RongJS as JSEngine>::Runtime>;

#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSValue = CoreJSValue<JSEngineValue>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSObject = CoreJSObject<JSEngineValue>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSProxy = CoreJSProxy<JSEngineValue>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSSymbol = CoreJSSymbol<JSEngineValue>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSFunc = CoreJSFunc<JSEngineValue>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSDate = CoreJSDate<JSEngineValue>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type Class = CoreClass<JSEngineValue>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type Promise = CorePromise<JSEngineValue>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSException = CoreJSException<JSEngineValue>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSArray = CoreJSArray<JSEngineValue>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSArrayBuffer = CoreJSArrayBuffer<JSEngineValue>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSBytes = CoreJSBytes<JSEngineValue>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type AnyJSTypedArray = CoreAnyJSTypedArray<JSEngineValue>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type JSTypedArray<T = u8> = CoreJSTypedArray<JSEngineValue, T>;
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub type PropertyDescriptor = CorePropertyDescriptor<JSEngineValue>;

// re-export macro public symbols to rong
pub use rong_macro::{FromJSObj, FromJSValue, IntoJSObj, js_class, js_export, js_method};

/// A Trait for conversion from JavaScript values.
#[cfg(any(feature = "quickjs", feature = "jscore", feature = "arkjs"))]
pub trait TryFromJSValue: Sized {
    fn try_from_js(_value: JSValue) -> JSResult<Self>;
}