Type Alias mozjs::jsapi::WriteStructuredCloneOp
source · pub type WriteStructuredCloneOp = Option<unsafe extern "C" fn(_: *mut JSContext, _: *mut JSStructuredCloneWriter, _: Handle<*mut JSObject>, _: *mut bool, _: *mut c_void) -> bool>;
Expand description
Structured data serialization hook. The engine can write primitive values, Objects, Arrays, Dates, RegExps, TypedArrays, ArrayBuffers, Sets, Maps, and SharedTypedArrays. Any other type of object requires application support. This callback must first use the JS_WriteUint32Pair API to write an object header, passing a value greater than JS_SCTAG_USER to the tag parameter. Then it can use the JS_Write* APIs to write any other relevant parts of the value v to the writer w. closure is any value passed to the JS_WriteStructuredClone function.
Return true on success, false on error. On error, an exception should normally be set.
Aliased Type§
enum WriteStructuredCloneOp {
None,
Some(unsafe extern "C" fn(_: *mut JSContext, _: *mut JSStructuredCloneWriter, _: Handle<*mut JSObject>, _: *mut bool, _: *mut c_void) -> bool),
}
Variants§
None
No value.
Some(unsafe extern "C" fn(_: *mut JSContext, _: *mut JSStructuredCloneWriter, _: Handle<*mut JSObject>, _: *mut bool, _: *mut c_void) -> bool)
Some value of type T
.
Trait Implementations§
source§impl<T: CustomTrace> CustomTrace for Option<T>
impl<T: CustomTrace> CustomTrace for Option<T>
source§impl<T: FromJSValConvertible> FromJSValConvertible for Option<T>
impl<T: FromJSValConvertible> FromJSValConvertible for Option<T>
§type Config = <T as FromJSValConvertible>::Config
type Config = <T as FromJSValConvertible>::Config
Optional configurable behaviour switch; use () for no configuration.
source§unsafe fn from_jsval(
cx: *mut JSContext,
value: HandleValue<'_>,
option: T::Config
) -> Result<ConversionResult<Option<T>>, ()>
unsafe fn from_jsval( cx: *mut JSContext, value: HandleValue<'_>, option: T::Config ) -> Result<ConversionResult<Option<T>>, ()>
Convert
val
to type Self
.
Optional configuration of type T
can be passed as the option
argument.
If it returns Err(())
, a JSAPI exception is pending.
If it returns Ok(Failure(reason))
, there is no pending JSAPI exception.