Skip to content

Commit 64c4fa2

Browse files
authored
Rename UninitSlice constructors for consistency with ReadBuf (#599)
tokio::io::ReadBuf uses names `new` and `uninit` for its constructors. For consistency with that, rename recently introduced UninitSlice constructors to match those names.
1 parent c7756c3 commit 64c4fa2

File tree

2 files changed

+24
-24
lines changed

2 files changed

+24
-24
lines changed

src/buf/buf_mut.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1427,7 +1427,7 @@ unsafe impl BufMut for &mut [core::mem::MaybeUninit<u8>] {
14271427

14281428
#[inline]
14291429
fn chunk_mut(&mut self) -> &mut UninitSlice {
1430-
UninitSlice::from_uninit_slice(self)
1430+
UninitSlice::uninit(self)
14311431
}
14321432

14331433
#[inline]

src/buf/uninit_slice.rs

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -22,42 +22,42 @@ use core::ops::{
2222
pub struct UninitSlice([MaybeUninit<u8>]);
2323

2424
impl UninitSlice {
25-
/// Creates a `&mut UninitSlice` wrapping slice of uninitialised memory.
25+
/// Creates a `&mut UninitSlice` wrapping a slice of initialised memory.
2626
///
2727
/// # Examples
2828
///
2929
/// ```
3030
/// use bytes::buf::UninitSlice;
31-
/// use core::mem::MaybeUninit;
32-
///
33-
/// let mut buffer = [MaybeUninit::uninit(); 64];
34-
/// let slice = UninitSlice::from_uninit_slice(&mut buffer[..]);
3531
///
36-
/// let mut vec = Vec::with_capacity(1024);
37-
/// let spare: &mut UninitSlice = vec.spare_capacity_mut().into();
32+
/// let mut buffer = [0u8; 64];
33+
/// let slice = UninitSlice::new(&mut buffer[..]);
3834
/// ```
3935
#[inline]
40-
pub fn from_uninit_slice(slice: &mut [MaybeUninit<u8>]) -> &mut UninitSlice {
41-
unsafe { &mut *(slice as *mut [MaybeUninit<u8>] as *mut UninitSlice) }
42-
}
43-
44-
fn from_uninit_slice_ref(slice: &[MaybeUninit<u8>]) -> &UninitSlice {
45-
unsafe { &*(slice as *const [MaybeUninit<u8>] as *const UninitSlice) }
36+
pub fn new(slice: &mut [u8]) -> &mut UninitSlice {
37+
unsafe { &mut *(slice as *mut [u8] as *mut [MaybeUninit<u8>] as *mut UninitSlice) }
4638
}
4739

48-
/// Creates a `&mut UninitSlice` wrapping slice of initialised memory.
40+
/// Creates a `&mut UninitSlice` wrapping a slice of uninitialised memory.
4941
///
5042
/// # Examples
5143
///
5244
/// ```
5345
/// use bytes::buf::UninitSlice;
46+
/// use core::mem::MaybeUninit;
5447
///
55-
/// let mut buffer = [0u8; 64];
56-
/// let slice = UninitSlice::from_slice(&mut buffer[..]);
48+
/// let mut buffer = [MaybeUninit::uninit(); 64];
49+
/// let slice = UninitSlice::uninit(&mut buffer[..]);
50+
///
51+
/// let mut vec = Vec::with_capacity(1024);
52+
/// let spare: &mut UninitSlice = vec.spare_capacity_mut().into();
5753
/// ```
5854
#[inline]
59-
pub fn from_slice(slice: &mut [u8]) -> &mut UninitSlice {
60-
unsafe { &mut *(slice as *mut [u8] as *mut [MaybeUninit<u8>] as *mut UninitSlice) }
55+
pub fn uninit(slice: &mut [MaybeUninit<u8>]) -> &mut UninitSlice {
56+
unsafe { &mut *(slice as *mut [MaybeUninit<u8>] as *mut UninitSlice) }
57+
}
58+
59+
fn uninit_ref(slice: &[MaybeUninit<u8>]) -> &UninitSlice {
60+
unsafe { &*(slice as *const [MaybeUninit<u8>] as *const UninitSlice) }
6161
}
6262

6363
/// Create a `&mut UninitSlice` from a pointer and a length.
@@ -82,7 +82,7 @@ impl UninitSlice {
8282
pub unsafe fn from_raw_parts_mut<'a>(ptr: *mut u8, len: usize) -> &'a mut UninitSlice {
8383
let maybe_init: &mut [MaybeUninit<u8>] =
8484
core::slice::from_raw_parts_mut(ptr as *mut _, len);
85-
Self::from_uninit_slice(maybe_init)
85+
Self::uninit(maybe_init)
8686
}
8787

8888
/// Write a single byte at the specified offset.
@@ -215,13 +215,13 @@ impl fmt::Debug for UninitSlice {
215215

216216
impl<'a> From<&'a mut [u8]> for &'a mut UninitSlice {
217217
fn from(slice: &'a mut [u8]) -> Self {
218-
UninitSlice::from_slice(slice)
218+
UninitSlice::new(slice)
219219
}
220220
}
221221

222222
impl<'a> From<&'a mut [MaybeUninit<u8>]> for &'a mut UninitSlice {
223223
fn from(slice: &'a mut [MaybeUninit<u8>]) -> Self {
224-
UninitSlice::from_uninit_slice(slice)
224+
UninitSlice::uninit(slice)
225225
}
226226
}
227227

@@ -233,14 +233,14 @@ macro_rules! impl_index {
233233

234234
#[inline]
235235
fn index(&self, index: $t) -> &UninitSlice {
236-
UninitSlice::from_uninit_slice_ref(&self.0[index])
236+
UninitSlice::uninit_ref(&self.0[index])
237237
}
238238
}
239239

240240
impl IndexMut<$t> for UninitSlice {
241241
#[inline]
242242
fn index_mut(&mut self, index: $t) -> &mut UninitSlice {
243-
UninitSlice::from_uninit_slice(&mut self.0[index])
243+
UninitSlice::uninit(&mut self.0[index])
244244
}
245245
}
246246
)*

0 commit comments

Comments
 (0)