Struct boa_engine::object::builtins::JsArrayBuffer
source · pub struct JsArrayBuffer { /* private fields */ }
Expand description
JsArrayBuffer
provides a wrapper for Boa’s implementation of the ECMAScript ArrayBuffer
object
Implementations§
source§impl JsArrayBuffer
impl JsArrayBuffer
sourcepub fn new(byte_length: usize, context: &mut Context) -> JsResult<Self>
pub fn new(byte_length: usize, context: &mut Context) -> JsResult<Self>
Create a new array buffer with byte length.
// Creates a blank array buffer of n bytes
let array_buffer = JsArrayBuffer::new(4, context)?;
assert_eq!(array_buffer.detach(&JsValue::undefined())?, vec![0_u8; 4]);
sourcepub fn from_byte_block(
byte_block: Vec<u8>,
context: &mut Context
) -> JsResult<Self>
pub fn from_byte_block( byte_block: Vec<u8>, context: &mut Context ) -> JsResult<Self>
Create a new array buffer from byte block.
This uses the passed byte block as the internal storage, it does not clone it!
The byte_length
will be set to byte_block.len()
.
// Create a buffer from a chunk of data
let data_block: Vec<u8> = (0..5).collect();
let array_buffer = JsArrayBuffer::from_byte_block(data_block, context)?;
assert_eq!(
array_buffer.detach(&JsValue::undefined())?,
(0..5).collect::<Vec<u8>>()
);
sourcepub fn from_object(object: JsObject) -> JsResult<Self>
pub fn from_object(object: JsObject) -> JsResult<Self>
Create a JsArrayBuffer
from a JsObject
, if the object is not an array buffer throw a TypeError
.
This does not clone the fields of the array buffer, it only does a shallow clone of the object.
sourcepub fn byte_length(&self) -> usize
pub fn byte_length(&self) -> usize
Returns the byte length of the array buffer.
// Create a buffer from a chunk of data
let data_block: Vec<u8> = (0..5).collect();
let array_buffer = JsArrayBuffer::from_byte_block(data_block, context)?;
// Take the inner buffer
let buffer_length = array_buffer.byte_length();
assert_eq!(buffer_length, 5);
sourcepub fn detach(&self, detach_key: &JsValue) -> JsResult<Vec<u8>>
pub fn detach(&self, detach_key: &JsValue) -> JsResult<Vec<u8>>
Take the inner ArrayBuffer
’s array_buffer_data
field and replace it with None
§Note
This tries to detach the pre-existing JsArrayBuffer
, meaning the original detach
key is required. By default, the key is set to undefined
.
// Create a buffer from a chunk of data
let data_block: Vec<u8> = (0..5).collect();
let array_buffer = JsArrayBuffer::from_byte_block(data_block, context)?;
// Take the inner buffer
let internal_buffer = array_buffer.detach(&JsValue::undefined())?;
assert_eq!(internal_buffer, (0..5).collect::<Vec<u8>>());
// Anymore interaction with the buffer will return an error
let detached_err = array_buffer.detach(&JsValue::undefined());
assert!(detached_err.is_err());
sourcepub fn data(&self) -> Option<GcRef<'_, [u8]>>
pub fn data(&self) -> Option<GcRef<'_, [u8]>>
Get an immutable reference to the JsArrayBuffer
’s data.
Returns None
if detached.
// Create a buffer from a chunk of data
let data_block: Vec<u8> = (0..5).collect();
let array_buffer = JsArrayBuffer::from_byte_block(data_block, context)?;
// Get a reference to the data.
let internal_buffer = array_buffer.data();
assert_eq!(
internal_buffer.as_deref(),
Some((0..5).collect::<Vec<u8>>().as_slice())
);
sourcepub fn data_mut(&self) -> Option<GcRefMut<'_, Object<ArrayBuffer>, [u8]>>
pub fn data_mut(&self) -> Option<GcRefMut<'_, Object<ArrayBuffer>, [u8]>>
Get a mutable reference to the JsArrayBuffer
’s data.
Returns None
if detached.
// Create a buffer from a chunk of data
let data_block: Vec<u8> = (0..5).collect();
let array_buffer = JsArrayBuffer::from_byte_block(data_block, context)?;
// Get a reference to the data.
let mut internal_buffer = array_buffer
.data_mut()
.expect("the buffer should not be detached");
internal_buffer.fill(10);
assert_eq!(&*internal_buffer, vec![10u8; 5].as_slice());
Methods from Deref<Target = JsObject<ArrayBuffer>>§
sourcepub fn downcast_ref<T: NativeObject>(&self) -> Option<Ref<'_, T>>
pub fn downcast_ref<T: NativeObject>(&self) -> Option<Ref<'_, T>>
Downcasts a reference to the object,
if the object is of type T
.
§Panics
Panics if the object is currently mutably borrowed.
sourcepub fn downcast_mut<T: NativeObject>(
&self
) -> Option<RefMut<'_, ErasedObject, T>>
pub fn downcast_mut<T: NativeObject>( &self ) -> Option<RefMut<'_, ErasedObject, T>>
Downcasts a mutable reference to the object,
if the object is type native object type T
.
§Panics
Panics if the object is currently borrowed.
sourcepub fn is<T: NativeObject>(&self) -> bool
pub fn is<T: NativeObject>(&self) -> bool
Checks if this object is an instance of a certain NativeObject
.
§Panics
Panics if the object is currently mutably borrowed.
sourcepub fn is_ordinary(&self) -> bool
pub fn is_ordinary(&self) -> bool
sourcepub fn to_property_descriptor(
&self,
context: &mut Context
) -> JsResult<PropertyDescriptor>
pub fn to_property_descriptor( &self, context: &mut Context ) -> JsResult<PropertyDescriptor>
sourcepub fn copy_data_properties<K>(
&self,
source: &JsValue,
excluded_keys: Vec<K>,
context: &mut Context
) -> JsResult<()>where
K: Into<PropertyKey>,
pub fn copy_data_properties<K>(
&self,
source: &JsValue,
excluded_keys: Vec<K>,
context: &mut Context
) -> JsResult<()>where
K: Into<PropertyKey>,
sourcepub fn borrow(&self) -> Ref<'_, Object<T>>
pub fn borrow(&self) -> Ref<'_, Object<T>>
Immutably borrows the Object
.
The borrow lasts until the returned Ref
exits scope.
Multiple immutable borrows can be taken out at the same time.
§Panics
Panics if the object is currently mutably borrowed.
sourcepub fn borrow_mut(&self) -> RefMut<'_, Object<T>, Object<T>>
pub fn borrow_mut(&self) -> RefMut<'_, Object<T>, Object<T>>
Mutably borrows the Object.
The borrow lasts until the returned RefMut
exits scope.
The object cannot be borrowed while this borrow is active.
§Panics
Panics if the object is currently borrowed.
sourcepub fn try_borrow(&self) -> StdResult<Ref<'_, Object<T>>, BorrowError>
pub fn try_borrow(&self) -> StdResult<Ref<'_, Object<T>>, BorrowError>
Immutably borrows the Object
, returning an error if the value is currently mutably borrowed.
The borrow lasts until the returned GcCellRef
exits scope.
Multiple immutable borrows can be taken out at the same time.
This is the non-panicking variant of borrow
.
sourcepub fn try_borrow_mut(
&self
) -> StdResult<RefMut<'_, Object<T>, Object<T>>, BorrowMutError>
pub fn try_borrow_mut( &self ) -> StdResult<RefMut<'_, Object<T>, Object<T>>, BorrowMutError>
Mutably borrows the object, returning an error if the value is currently borrowed.
The borrow lasts until the returned GcCellRefMut
exits scope.
The object be borrowed while this borrow is active.
This is the non-panicking variant of borrow_mut
.
sourcepub fn prototype(&self) -> JsPrototype
pub fn prototype(&self) -> JsPrototype
sourcepub fn set_prototype(&self, prototype: JsPrototype) -> bool
pub fn set_prototype(&self, prototype: JsPrototype) -> bool
sourcepub fn insert_property<K, P>(&self, key: K, property: P) -> bool
pub fn insert_property<K, P>(&self, key: K, property: P) -> bool
Inserts a field in the object properties
without checking if it’s writable.
If a field was already in the object with the same name, than true
is returned
with that field, otherwise false
is returned.
sourcepub fn is_callable(&self) -> bool
pub fn is_callable(&self) -> bool
It determines if Object is a callable function with a [[Call]]
internal method.
More information:
sourcepub fn is_constructor(&self) -> bool
pub fn is_constructor(&self) -> bool
It determines if Object is a function object with a [[Construct]]
internal method.
More information:
sourcepub fn is_extensible(&self, context: &mut Context) -> JsResult<bool>
pub fn is_extensible(&self, context: &mut Context) -> JsResult<bool>
sourcepub fn get<K>(&self, key: K, context: &mut Context) -> JsResult<JsValue>where
K: Into<PropertyKey>,
pub fn get<K>(&self, key: K, context: &mut Context) -> JsResult<JsValue>where
K: Into<PropertyKey>,
sourcepub fn set<K, V>(
&self,
key: K,
value: V,
throw: bool,
context: &mut Context
) -> JsResult<bool>
pub fn set<K, V>( &self, key: K, value: V, throw: bool, context: &mut Context ) -> JsResult<bool>
sourcepub fn create_data_property<K, V>(
&self,
key: K,
value: V,
context: &mut Context
) -> JsResult<bool>
pub fn create_data_property<K, V>( &self, key: K, value: V, context: &mut Context ) -> JsResult<bool>
sourcepub fn create_data_property_or_throw<K, V>(
&self,
key: K,
value: V,
context: &mut Context
) -> JsResult<bool>
pub fn create_data_property_or_throw<K, V>( &self, key: K, value: V, context: &mut Context ) -> JsResult<bool>
sourcepub fn define_property_or_throw<K, P>(
&self,
key: K,
desc: P,
context: &mut Context
) -> JsResult<bool>
pub fn define_property_or_throw<K, P>( &self, key: K, desc: P, context: &mut Context ) -> JsResult<bool>
sourcepub fn delete_property_or_throw<K>(
&self,
key: K,
context: &mut Context
) -> JsResult<bool>where
K: Into<PropertyKey>,
pub fn delete_property_or_throw<K>(
&self,
key: K,
context: &mut Context
) -> JsResult<bool>where
K: Into<PropertyKey>,
Defines the property or throws a TypeError
if the operation fails.
More information:
sourcepub fn has_property<K>(&self, key: K, context: &mut Context) -> JsResult<bool>where
K: Into<PropertyKey>,
pub fn has_property<K>(&self, key: K, context: &mut Context) -> JsResult<bool>where
K: Into<PropertyKey>,
sourcepub fn has_own_property<K>(
&self,
key: K,
context: &mut Context
) -> JsResult<bool>where
K: Into<PropertyKey>,
pub fn has_own_property<K>(
&self,
key: K,
context: &mut Context
) -> JsResult<bool>where
K: Into<PropertyKey>,
sourcepub fn call(
&self,
this: &JsValue,
args: &[JsValue],
context: &mut Context
) -> JsResult<JsValue>
pub fn call( &self, this: &JsValue, args: &[JsValue], context: &mut Context ) -> JsResult<JsValue>
Call ( F, V [ , argumentsList ] )
§Panics
Panics if the object is currently mutably borrowed.
More information:
sourcepub fn construct(
&self,
args: &[JsValue],
new_target: Option<&Self>,
context: &mut Context
) -> JsResult<Self>
pub fn construct( &self, args: &[JsValue], new_target: Option<&Self>, context: &mut Context ) -> JsResult<Self>
Construct ( F [ , argumentsList [ , newTarget ] ] )
Construct an instance of this object with the specified arguments.
§Panics
Panics if the object is currently mutably borrowed.
More information:
sourcepub fn set_integrity_level(
&self,
level: IntegrityLevel,
context: &mut Context
) -> JsResult<bool>
pub fn set_integrity_level( &self, level: IntegrityLevel, context: &mut Context ) -> JsResult<bool>
sourcepub fn test_integrity_level(
&self,
level: IntegrityLevel,
context: &mut Context
) -> JsResult<bool>
pub fn test_integrity_level( &self, level: IntegrityLevel, context: &mut Context ) -> JsResult<bool>
Trait Implementations§
source§impl Clone for JsArrayBuffer
impl Clone for JsArrayBuffer
source§fn clone(&self) -> JsArrayBuffer
fn clone(&self) -> JsArrayBuffer
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for JsArrayBuffer
impl Debug for JsArrayBuffer
source§impl Deref for JsArrayBuffer
impl Deref for JsArrayBuffer
source§impl From<JsArrayBuffer> for JsObject
impl From<JsArrayBuffer> for JsObject
source§fn from(o: JsArrayBuffer) -> Self
fn from(o: JsArrayBuffer) -> Self
source§impl From<JsArrayBuffer> for JsObject<ArrayBuffer>
impl From<JsArrayBuffer> for JsObject<ArrayBuffer>
source§fn from(value: JsArrayBuffer) -> Self
fn from(value: JsArrayBuffer) -> Self
source§impl From<JsArrayBuffer> for JsValue
impl From<JsArrayBuffer> for JsValue
source§fn from(o: JsArrayBuffer) -> Self
fn from(o: JsArrayBuffer) -> Self
source§impl From<JsObject<ArrayBuffer>> for JsArrayBuffer
impl From<JsObject<ArrayBuffer>> for JsArrayBuffer
source§fn from(value: JsObject<ArrayBuffer>) -> Self
fn from(value: JsObject<ArrayBuffer>) -> Self
source§impl Trace for JsArrayBuffer
impl Trace for JsArrayBuffer
source§unsafe fn trace_non_roots(&self)
unsafe fn trace_non_roots(&self)
source§fn run_finalizer(&self)
fn run_finalizer(&self)
Finalize::finalize
on this object and all
contained subobjects.source§impl TryFromJs for JsArrayBuffer
impl TryFromJs for JsArrayBuffer
Auto Trait Implementations§
impl !RefUnwindSafe for JsArrayBuffer
impl !Send for JsArrayBuffer
impl !Sync for JsArrayBuffer
impl Unpin for JsArrayBuffer
impl !UnwindSafe for JsArrayBuffer
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.