openworkers-serde-v8 146.0.0

Rust to V8 serialization and deserialization for OpenWorkers
Documentation
// Copyright 2018-2025 the Deno authors. MIT license.

use std::cell::RefCell;
use std::fmt::Debug;
use std::ops::Deref;
use std::ops::DerefMut;

use super::transl8::FromV8;
use super::transl8::ToV8;
use super::v8slice::V8Slice;
use crate::magic::transl8::impl_magic;

pub struct JsBuffer(V8Slice<u8>);

impl_magic!(JsBuffer);

impl JsBuffer {
    pub fn from_parts(slice: V8Slice<u8>) -> Self {
        Self(slice)
    }

    /// Returns the buffer to its parts.
    pub fn into_parts(self) -> V8Slice<u8> {
        self.0
    }
}

impl Debug for JsBuffer {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_list().entries(self.0.as_ref().iter()).finish()
    }
}

impl Clone for JsBuffer {
    fn clone(&self) -> Self {
        Self(self.0.clone())
    }
}

impl AsRef<[u8]> for JsBuffer {
    fn as_ref(&self) -> &[u8] {
        &self.0
    }
}

impl AsMut<[u8]> for JsBuffer {
    fn as_mut(&mut self) -> &mut [u8] {
        &mut self.0
    }
}

impl Deref for JsBuffer {
    type Target = [u8];
    fn deref(&self) -> &[u8] {
        &self.0
    }
}

impl DerefMut for JsBuffer {
    fn deref_mut(&mut self) -> &mut [u8] {
        &mut self.0
    }
}

impl FromV8 for JsBuffer {
    fn from_v8<'scope, 'i>(
        scope: &mut v8::PinScope<'scope, 'i>,
        value: v8::Local<'scope, v8::Value>,
    ) -> Result<Self, crate::Error> {
        Ok(Self(V8Slice::from_v8(scope, value)?))
    }
}

impl From<V8Slice<u8>> for JsBuffer {
    fn from(value: V8Slice<u8>) -> Self {
        JsBuffer(value)
    }
}

// NOTE(bartlomieju): we use Option here, because `to_v8()` uses `&mut self`
// instead of `self` which is dictated by the `serde` API.
#[derive(Debug)]
pub struct ToJsBuffer(RefCell<Option<Box<[u8]>>>);

impl_magic!(ToJsBuffer);

impl ToJsBuffer {
    pub fn empty() -> Self {
        ToJsBuffer(Some(vec![0_u8; 0].into_boxed_slice()).into())
    }
}

impl From<Box<[u8]>> for ToJsBuffer {
    fn from(buf: Box<[u8]>) -> Self {
        ToJsBuffer(Some(buf).into())
    }
}

impl From<Vec<u8>> for ToJsBuffer {
    fn from(vec: Vec<u8>) -> Self {
        vec.into_boxed_slice().into()
    }
}

impl From<bytes::Bytes> for ToJsBuffer {
    /// Convert Bytes to ToJsBuffer, potentially avoiding a copy if Bytes is uniquely owned.
    fn from(bytes: bytes::Bytes) -> Self {
        // bytes.into() -> Vec<u8> avoids copy if Bytes owns the data exclusively
        let vec: Vec<u8> = bytes.into();
        vec.into_boxed_slice().into()
    }
}

impl ToV8 for ToJsBuffer {
    fn to_v8<'scope, 'i>(
        &self,
        scope: &mut v8::PinScope<'scope, 'i>,
    ) -> Result<v8::Local<'scope, v8::Value>, crate::Error> {
        let buf: Box<[u8]> = self.0.borrow_mut().take().expect("RustToV8Buf was empty");

        if buf.is_empty() {
            let ab = v8::ArrayBuffer::new(scope, 0);
            return Ok(v8::Uint8Array::new(scope, ab, 0, 0)
                .expect("Failed to create Uint8Array")
                .into());
        }

        let buf_len: usize = buf.len();

        // In sandbox mode, V8 must allocate memory itself (security restriction).
        // We create an ArrayBuffer and copy data into it.
        #[cfg(feature = "v8_enable_sandbox")]
        let ab = {
            let ab = v8::ArrayBuffer::new(scope, buf_len);
            let bs = ab.get_backing_store();
            // SAFETY: We just created this ArrayBuffer, so we have exclusive access.
            // The backing store data is valid for the lifetime of the ArrayBuffer.
            let data = bs.data().unwrap().as_ptr() as *mut u8;
            unsafe {
                std::ptr::copy_nonoverlapping(buf.as_ptr(), data, buf_len);
            }
            ab
        };

        // In non-sandbox mode, we can create a backing store from Rust memory directly.
        #[cfg(not(feature = "v8_enable_sandbox"))]
        let ab = {
            let backing_store = v8::ArrayBuffer::new_backing_store_from_boxed_slice(buf);
            let backing_store_shared = backing_store.make_shared();
            v8::ArrayBuffer::with_backing_store(scope, &backing_store_shared)
        };

        Ok(v8::Uint8Array::new(scope, ab, 0, buf_len)
            .expect("Failed to create Uint8Array")
            .into())
    }
}