extendr_api/wrapper/
raw.rs

Help
1use super::*;
2
3/// Wrapper for creating raw (byte) objects.
4///
5/// ```
6/// use extendr_api::prelude::*;
7/// test! {
8///     let bytes = r!(Raw::from_bytes(&[1, 2, 3]));
9///     assert_eq!(bytes.len(), 3);
10///     assert_eq!(bytes.as_raw(), Some(Raw::from_bytes(&[1, 2, 3])));
11/// }
12/// ```
13///
14#[derive(PartialEq, Clone)]
15pub struct Raw {
16    pub(crate) robj: Robj,
17}
18
19fn init_raw<F: FnOnce(&mut [u8])>(len: usize, filler: F) -> Raw {
20    let mut robj = Robj::alloc_vector(SEXPTYPE::RAWSXP, len);
21    let slice = robj.as_raw_slice_mut().unwrap();
22    filler(slice);
23    Raw { robj }
24}
25
26impl Raw {
27    /// Create a new Raw object of length `len`.
28    /// ```
29    /// use extendr_api::prelude::*;
30    /// test! {
31    ///     let bytes = Raw::new(42);
32    ///     assert_eq!(bytes.len(), 42);
33    ///     assert_eq!(bytes.as_slice(),  &(0..42).map(|_| 0u8).collect::<Vec<_>>());
34    /// }
35    /// ```
36    pub fn new(len: usize) -> Raw {
37        init_raw(len, |slice| slice.fill(0))
38    }
39
40    /// ```
41    /// use extendr_api::prelude::*;
42    /// test! {
43    ///     let bytes = Raw::from_bytes(&[1, 2, 3]);
44    ///     assert_eq!(bytes.len(), 3);
45    ///     assert_eq!(bytes.as_slice(), &[1, 2, 3]);
46    /// }
47    /// ```
48    pub fn from_bytes(bytes: &[u8]) -> Self {
49        init_raw(bytes.len(), |slice| slice.copy_from_slice(bytes))
50    }
51
52    /// Get a slice of bytes from the Raw object.
53    pub fn as_slice(&self) -> &[u8] {
54        self.robj.as_typed_slice().unwrap()
55    }
56}
57
58impl std::fmt::Debug for Raw {
59    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
60        f.write_str("Raw")?;
61        f.debug_list().entries(self.as_slice()).finish()
62    }
63}
64
65impl From<Option<Raw>> for Robj {
66    fn from(value: Option<Raw>) -> Self {
67        match value {
68            None => nil_value(),
69            Some(value) => value.into(),
70        }
71    }
72}
extendr_api/wrapper/raw.rs

extendr_api/wrapper/
raw.rs
