Struct neon::types::JsBuffer

#[repr(transparent)]
pub struct JsBuffer(_);

The Node Buffer type.

Implementations

impl JsBuffer

pub fn new<'a, C: Context<'a>>(cx: &mut C, len: usize) -> JsResult<'a, Self>

Constructs a new Buffer object, safely zero-filled.

pub unsafe fn uninitialized<'a, C: Context<'a>>(
    cx: &mut C,
    len: usize
) -> JsResult<'a, Self>

Constructs a new Buffer object with uninitialized memory

pub fn external<'a, C, T>(cx: &mut C, data: T) -> Handle<'a, Self> where
    C: Context<'a>,
    T: AsMut<[u8]> + Send + 'static, 

Construct a new Buffer from bytes allocated by Rust

Trait Implementations

impl Debug for JsBuffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Managed for JsBuffer

fn to_raw(&self) -> *mut Value__

fn from_raw(_env: Env, h: *mut Value__) -> Self

impl Object for JsBuffer

fn get_opt<'a, V: Value, C: Context<'a>, K: PropertyKey>(
    &self,
    cx: &mut C,
    key: K
) -> NeonResult<Option<Handle<'a, V>>>

Gets a property from a JavaScript object that may be undefined and attempts to downcast the value if it existed.

fn get_value<'a, C: Context<'a>, K: PropertyKey>(
    &self,
    cx: &mut C,
    key: K
) -> NeonResult<Handle<'a, JsValue>>

Gets a property from a JavaScript object as a JsValue.

fn get<'a, V: Value, C: Context<'a>, K: PropertyKey>(
    &self,
    cx: &mut C,
    key: K
) -> NeonResult<Handle<'a, V>>

Gets a property from a JavaScript object and attempts to downcast as a specific type. Equivalent to calling obj.get_value(&mut cx)?.downcast_or_throw(&mut cx).

fn get_own_property_names<'a, C: Context<'a>>(
    &self,
    cx: &mut C
) -> JsResult<'a, JsArray>

Available on crate feature napi-6 only.

fn freeze<'a, C: Context<'a>>(&self, cx: &mut C) -> NeonResult<&Self>

fn seal<'a, C: Context<'a>>(&self, cx: &mut C) -> NeonResult<&Self>

fn set<'a, C: Context<'a>, K: PropertyKey, W: Value>(
    &self,
    cx: &mut C,
    key: K,
    val: Handle<'_, W>
) -> NeonResult<bool>

fn root<'a, C: Context<'a>>(&self, cx: &mut C) -> Root<Self>

fn call_method_with<'a, C, K>(
    &self,
    cx: &mut C,
    method: K
) -> NeonResult<CallOptions<'a>> where
    C: Context<'a>,
    K: PropertyKey, 

impl TypedArray for JsBuffer

type Item = u8

fn as_slice<'cx, 'a, C>(&self, cx: &'a C) -> &'a [Self::Item] where
    C: Context<'cx>, 

Statically checked immutable borrow of binary data.

fn as_mut_slice<'cx, 'a, C>(&mut self, cx: &'a mut C) -> &'a mut [Self::Item] where
    C: Context<'cx>, 

Statically checked mutable borrow of binary data.

fn try_borrow<'cx, 'a, C>(
    &self,
    lock: &'a Lock<'_, C>
) -> Result<Ref<'a, Self::Item>, BorrowError> where
    C: Context<'cx>, 

Dynamically checked immutable borrow of binary data, returning an error if the the borrow would overlap with a mutable borrow.

fn try_borrow_mut<'cx, 'a, C>(
    &mut self,
    lock: &'a Lock<'_, C>
) -> Result<RefMut<'a, Self::Item>, BorrowError> where
    C: Context<'cx>, 

Dynamically checked mutable borrow of binary data, returning an error if the the borrow would overlap with an active borrow.

impl Value for JsBuffer

fn to_string<'a, C: Context<'a>>(&self, cx: &mut C) -> JsResult<'a, JsString>

fn as_value<'a, C: Context<'a>>(&self, _: &mut C) -> Handle<'a, JsValue>