Struct js::jsapi::JSAutoStructuredCloneBuffer

#[repr(C)]
pub struct JSAutoStructuredCloneBuffer {
    pub data_: *mut u64,
    pub nbytes_: usize,
    pub version_: u32,
    pub ownTransferables_: JSAutoStructuredCloneBuffer_StructuredClone_h_unnamed_7,
    pub callbacks_: *const JSStructuredCloneCallbacks,
    pub closure_: *mut c_void,
}

RAII sugar for JS_WriteStructuredClone.

Fields

data_: *mut u64

nbytes_: usize

version_: u32

ownTransferables_: JSAutoStructuredCloneBuffer_StructuredClone_h_unnamed_7

callbacks_: *const JSStructuredCloneCallbacks

closure_: *mut c_void

Methods

impl JSAutoStructuredCloneBuffer

pub unsafe fn clear(
    &mut self,
    optionalCallbacks: *const JSStructuredCloneCallbacks,
    closure: *mut c_void
)

pub unsafe fn copy(
    &mut self,
    data: *const u64,
    nbytes: usize,
    version: u32,
    callbacks: *const JSStructuredCloneCallbacks,
    closure: *mut c_void
) -> bool

Copy some memory. It will be automatically freed by the destructor.

pub unsafe fn adopt(
    &mut self,
    data: *mut u64,
    nbytes: usize,
    version: u32,
    callbacks: *const JSStructuredCloneCallbacks,
    closure: *mut c_void
)

Adopt some memory. It will be automatically freed by the destructor. data must have been allocated by the JS engine (e.g., extracted via JSAutoStructuredCloneBuffer::steal).

pub unsafe fn steal(
    &mut self,
    datap: *mut *mut u64,
    nbytesp: *mut usize,
    versionp: *mut u32,
    callbacks: *mut *const JSStructuredCloneCallbacks,
    closure: *mut *mut c_void
)

Release the buffer and transfer ownership to the caller. The caller is responsible for calling JS_ClearStructuredClone or feeding the memory back to JSAutoStructuredCloneBuffer::adopt.

pub unsafe fn read(
    &mut self,
    cx: *mut JSContext,
    vp: MutableHandleValue,
    optionalCallbacks: *const JSStructuredCloneCallbacks,
    closure: *mut c_void
) -> bool

pub unsafe fn write(
    &mut self,
    cx: *mut JSContext,
    v: HandleValue,
    optionalCallbacks: *const JSStructuredCloneCallbacks,
    closure: *mut c_void
) -> bool

pub unsafe fn write1(
    &mut self,
    cx: *mut JSContext,
    v: HandleValue,
    transferable: HandleValue,
    optionalCallbacks: *const JSStructuredCloneCallbacks,
    closure: *mut c_void
) -> bool

Trait Implementations

impl Debug for JSAutoStructuredCloneBuffer

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.