napi/js_values/
buffer.rs

1use std::mem;
2use std::ops::{Deref, DerefMut};
3use std::ptr;
4
5use crate::{
6  bindgen_runtime::{FromNapiValue, TypeName, ValidateNapiValue},
7  check_status, sys, Env, Error, JsValue, Ref, Result, Status, Unknown, Value, ValueType,
8};
9
10#[deprecated(since = "3.0.0", note = "Please use Buffer or &[u8] instead")]
11pub struct JsBuffer(pub(crate) Value);
12
13impl TypeName for JsBuffer {
14  fn type_name() -> &'static str {
15    "Buffer"
16  }
17
18  fn value_type() -> ValueType {
19    ValueType::Object
20  }
21}
22
23impl ValidateNapiValue for JsBuffer {
24  unsafe fn validate(env: sys::napi_env, napi_val: sys::napi_value) -> Result<sys::napi_value> {
25    let mut is_buffer = false;
26    check_status!(unsafe { sys::napi_is_buffer(env, napi_val, &mut is_buffer) })?;
27    if !is_buffer {
28      return Err(Error::new(
29        Status::InvalidArg,
30        "Value is not a buffer".to_owned(),
31      ));
32    }
33    Ok(ptr::null_mut())
34  }
35}
36
37impl FromNapiValue for JsBuffer {
38  unsafe fn from_napi_value(env: sys::napi_env, napi_val: sys::napi_value) -> Result<Self> {
39    Ok(JsBuffer(Value {
40      env,
41      value: napi_val,
42      value_type: ValueType::Object,
43    }))
44  }
45}
46
47impl JsValue<'_> for JsBuffer {
48  fn value(&self) -> Value {
49    self.0
50  }
51}
52
53#[deprecated(since = "3.0.0", note = "Please use Buffer or &[u8] instead")]
54pub struct JsBufferValue {
55  pub(crate) value: JsBuffer,
56  data: mem::ManuallyDrop<Vec<u8>>,
57}
58
59impl JsBuffer {
60  pub fn into_value(self) -> Result<JsBufferValue> {
61    let mut data = ptr::null_mut();
62    let mut len: usize = 0;
63    check_status!(unsafe {
64      sys::napi_get_buffer_info(self.0.env, self.0.value, &mut data, &mut len)
65    })?;
66    Ok(JsBufferValue {
67      data: mem::ManuallyDrop::new(unsafe { Vec::from_raw_parts(data as *mut _, len, len) }),
68      value: self,
69    })
70  }
71
72  pub fn into_ref(self) -> Result<Ref<JsBuffer>> {
73    Ref::new(&Env::from(self.0.env), &self)
74  }
75}
76
77impl JsBufferValue {
78  pub fn new(value: JsBuffer, data: mem::ManuallyDrop<Vec<u8>>) -> Self {
79    JsBufferValue { value, data }
80  }
81
82  pub fn into_raw(self) -> JsBuffer {
83    self.value
84  }
85
86  pub fn into_unknown<'env>(self) -> Unknown<'env> {
87    unsafe { Unknown::from_raw_unchecked(self.value.0.env, self.value.0.value) }
88  }
89}
90
91impl AsRef<[u8]> for JsBufferValue {
92  fn as_ref(&self) -> &[u8] {
93    self.data.as_slice()
94  }
95}
96
97impl AsMut<[u8]> for JsBufferValue {
98  fn as_mut(&mut self) -> &mut [u8] {
99    self.data.as_mut_slice()
100  }
101}
102
103impl Deref for JsBufferValue {
104  type Target = [u8];
105
106  fn deref(&self) -> &Self::Target {
107    self.data.as_slice()
108  }
109}
110
111impl DerefMut for JsBufferValue {
112  fn deref_mut(&mut self) -> &mut Self::Target {
113    self.data.as_mut_slice()
114  }
115}