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  len: usize,
57  data_ptr: *mut u8,
58  owned: Option<mem::ManuallyDrop<Vec<u8>>>,
59}
60
61impl JsBuffer {
62  pub fn into_value(self) -> Result<JsBufferValue> {
63    let mut data = ptr::null_mut();
64    let mut len: usize = 0;
65    check_status!(unsafe {
66      sys::napi_get_buffer_info(self.0.env, self.0.value, &mut data, &mut len)
67    })?;
68    Ok(JsBufferValue {
69      value: self,
70      len,
71      data_ptr: data as *mut u8,
72      owned: None,
73    })
74  }
75
76  pub fn into_ref(self) -> Result<Ref<JsBuffer>> {
77    Ref::new(&Env::from(self.0.env), &self)
78  }
79}
80
81impl JsBufferValue {
82  pub fn new(value: JsBuffer, data: mem::ManuallyDrop<Vec<u8>>) -> Self {
83    let len = data.len();
84    let data_ptr = if len == 0 {
85      std::ptr::null_mut()
86    } else {
87      data.as_ptr() as *mut u8
88    };
89    JsBufferValue {
90      value,
91      len,
92      data_ptr,
93      owned: Some(data),
94    }
95  }
96
97  pub fn into_raw(self) -> JsBuffer {
98    self.value
99  }
100
101  pub fn into_unknown<'env>(self) -> Unknown<'env> {
102    unsafe { Unknown::from_raw_unchecked(self.value.0.env, self.value.0.value) }
103  }
104}
105
106impl AsRef<[u8]> for JsBufferValue {
107  fn as_ref(&self) -> &[u8] {
108    if let Some(ref data) = self.owned {
109      data.as_slice()
110    } else if self.len == 0 {
111      &[]
112    } else {
113      unsafe { std::slice::from_raw_parts(self.data_ptr as *const u8, self.len) }
114    }
115  }
116}
117
118impl AsMut<[u8]> for JsBufferValue {
119  fn as_mut(&mut self) -> &mut [u8] {
120    if let Some(ref mut data) = self.owned {
121      data.as_mut_slice()
122    } else if self.len == 0 {
123      &mut []
124    } else {
125      unsafe { std::slice::from_raw_parts_mut(self.data_ptr, self.len) }
126    }
127  }
128}
129
130impl Deref for JsBufferValue {
131  type Target = [u8];
132
133  fn deref(&self) -> &Self::Target {
134    self.as_ref()
135  }
136}
137
138impl DerefMut for JsBufferValue {
139  fn deref_mut(&mut self) -> &mut Self::Target {
140    self.as_mut()
141  }
142}
napi/js_values/buffer.rs

napi/js_values/
buffer.rs
