cstrptr 0.1.3

FFI-compatible and no-std &CStr
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

use {
    crate::{CStr, CStrPtr},
    alloc::{boxed::Box, string::String, vec::Vec},
    core::ops,
    cty::c_char,
};

#[derive(Default, Clone)]
pub struct CString {
    inner: Box<[u8]>,
}

impl CString {
    pub fn new<T: Into<Vec<u8>>>(bytes: T) -> Result<Self, Vec<u8>> {
        let bytes = bytes.into();
        match CStr::from_bytes_with_nul(&bytes) {
            Err(crate::FromBytesWithNulError::NotNulTerminated) =>
                Ok(unsafe { Self::from_bytes_with_nul_unchecked(bytes) }),
            _ => Err(bytes), // TODO: NulError
        }
    }

    pub fn from_bytes_with_nul<T: Into<Box<[u8]>>>(bytes: T) -> Result<Self, Box<[u8]>> {
        let bytes = bytes.into();
        match CStr::from_bytes_with_nul(&bytes) {
            Ok(_) => Ok(unsafe { Self::from_bytes_with_nul_unchecked(bytes) }),
            Err(_) => Err(bytes), // TODO: NulError
        }
    }

    pub unsafe fn from_vec_unchecked(mut v: Vec<u8>) -> Self {
        v.reserve_exact(1);
        v.push(0);
        Self::from_bytes_with_nul_unchecked(v)
    }

    #[inline]
    pub unsafe fn from_bytes_with_nul_unchecked<T: Into<Box<[u8]>>>(bytes: T) -> Self {
        Self { inner: bytes.into() }
    }

    pub unsafe fn from_raw(ptr: *mut c_char) -> Self {
        let len = CStr::from_ptr(ptr).to_bytes_with_nul().len();
        let slice = core::slice::from_raw_parts_mut(ptr, len);
        Self {
            inner: Box::from_raw(slice as *mut [_] as *mut [u8]),
        }
    }

    #[inline]
    pub fn into_raw(self) -> *mut c_char {
        Box::into_raw(self.inner) as *mut c_char
    }

    pub fn into_string(self) -> Result<String, Self> {
        String::from_utf8(self.into_bytes()).map_err(|e|
            // TODO: custom error type
            unsafe { Self::from_vec_unchecked(e.into_bytes()) })
    }

    pub fn into_bytes(self) -> Vec<u8> {
        let mut vec = self.inner.into_vec();
        let _nul = vec.pop();
        debug_assert_eq!(_nul, Some(0u8));
        vec
    }

    #[inline]
    pub fn into_bytes_with_nul(self) -> Vec<u8> {
        self.inner.into_vec()
    }

    #[inline]
    pub fn as_c_str(&self) -> &CStr {
        unsafe { CStr::from_bytes_with_nul_unchecked(&self.inner[..]) }
    }

    #[inline]
    pub fn into_boxed_c_str(self) -> Box<CStr> {
        unsafe { Box::from_raw(Box::into_raw(self.inner) as *mut CStr) }
    }
}

impl ops::Index<ops::RangeFull> for CString {
    type Output = CStr;

    #[inline]
    fn index(&self, _index: ops::RangeFull) -> &CStr {
        self.as_c_str()
    }
}

impl From<&CStr> for CString {
    #[inline]
    fn from(s: &CStr) -> Self {
        Self {
            inner: s.to_bytes_with_nul().into(),
        }
    }
}

impl<'a> From<CStrPtr<'a>> for CString {
    #[inline]
    fn from(s: CStrPtr<'a>) -> Self {
        s.to_c_str().into()
    }
}

impl AsRef<CStr> for CString {
    #[inline]
    fn as_ref(&self) -> &CStr {
        self.as_c_str()
    }
}

impl alloc::borrow::ToOwned for CStr {
    type Owned = CString;

    #[inline]
    fn to_owned(&self) -> Self::Owned {
        CString {
            inner: self.to_bytes_with_nul().into(),
        }
    }
}

impl alloc::borrow::Borrow<CStr> for CString {
    #[inline]
    fn borrow(&self) -> &CStr {
        self.as_c_str()
    }
}

impl ops::Deref for CString {
    type Target = CStr;

    fn deref(&self) -> &CStr {
        self.as_c_str()
    }
}