Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename UninitSlice constructors for consistency with ReadBuf #599

Merged
merged 1 commit into from
Jun 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/buf/buf_mut.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1427,7 +1427,7 @@ unsafe impl BufMut for &mut [core::mem::MaybeUninit<u8>] {

#[inline]
fn chunk_mut(&mut self) -> &mut UninitSlice {
UninitSlice::from_uninit_slice(self)
UninitSlice::uninit(self)
}

#[inline]
Expand Down
46 changes: 23 additions & 23 deletions src/buf/uninit_slice.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,42 +22,42 @@ use core::ops::{
pub struct UninitSlice([MaybeUninit<u8>]);

impl UninitSlice {
/// Creates a `&mut UninitSlice` wrapping slice of uninitialised memory.
/// Creates a `&mut UninitSlice` wrapping a slice of initialised memory.
///
/// # Examples
///
/// ```
/// use bytes::buf::UninitSlice;
/// use core::mem::MaybeUninit;
///
/// let mut buffer = [MaybeUninit::uninit(); 64];
/// let slice = UninitSlice::from_uninit_slice(&mut buffer[..]);
///
/// let mut vec = Vec::with_capacity(1024);
/// let spare: &mut UninitSlice = vec.spare_capacity_mut().into();
/// let mut buffer = [0u8; 64];
/// let slice = UninitSlice::new(&mut buffer[..]);
/// ```
#[inline]
pub fn from_uninit_slice(slice: &mut [MaybeUninit<u8>]) -> &mut UninitSlice {
unsafe { &mut *(slice as *mut [MaybeUninit<u8>] as *mut UninitSlice) }
}

fn from_uninit_slice_ref(slice: &[MaybeUninit<u8>]) -> &UninitSlice {
unsafe { &*(slice as *const [MaybeUninit<u8>] as *const UninitSlice) }
pub fn new(slice: &mut [u8]) -> &mut UninitSlice {
unsafe { &mut *(slice as *mut [u8] as *mut [MaybeUninit<u8>] as *mut UninitSlice) }
}

Comment on lines -40 to 39
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess the only reason this isn't a breaking change is that we haven't yet released the from_uninit_slice method.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right. v1.4.0 had only from_raw_parts_mut public constructor and
it’s not changed. from_slice is changed but it’s pub(crate) so it
doesn’t affect the API.

/// Creates a `&mut UninitSlice` wrapping slice of initialised memory.
/// Creates a `&mut UninitSlice` wrapping a slice of uninitialised memory.
///
/// # Examples
///
/// ```
/// use bytes::buf::UninitSlice;
/// use core::mem::MaybeUninit;
///
/// let mut buffer = [0u8; 64];
/// let slice = UninitSlice::from_slice(&mut buffer[..]);
/// let mut buffer = [MaybeUninit::uninit(); 64];
/// let slice = UninitSlice::uninit(&mut buffer[..]);
///
/// let mut vec = Vec::with_capacity(1024);
/// let spare: &mut UninitSlice = vec.spare_capacity_mut().into();
/// ```
#[inline]
pub fn from_slice(slice: &mut [u8]) -> &mut UninitSlice {
unsafe { &mut *(slice as *mut [u8] as *mut [MaybeUninit<u8>] as *mut UninitSlice) }
pub fn uninit(slice: &mut [MaybeUninit<u8>]) -> &mut UninitSlice {
unsafe { &mut *(slice as *mut [MaybeUninit<u8>] as *mut UninitSlice) }
}

fn uninit_ref(slice: &[MaybeUninit<u8>]) -> &UninitSlice {
unsafe { &*(slice as *const [MaybeUninit<u8>] as *const UninitSlice) }
}

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

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

impl<'a> From<&'a mut [u8]> for &'a mut UninitSlice {
fn from(slice: &'a mut [u8]) -> Self {
UninitSlice::from_slice(slice)
UninitSlice::new(slice)
}
}

impl<'a> From<&'a mut [MaybeUninit<u8>]> for &'a mut UninitSlice {
fn from(slice: &'a mut [MaybeUninit<u8>]) -> Self {
UninitSlice::from_uninit_slice(slice)
UninitSlice::uninit(slice)
}
}

Expand All @@ -233,14 +233,14 @@ macro_rules! impl_index {

#[inline]
fn index(&self, index: $t) -> &UninitSlice {
UninitSlice::from_uninit_slice_ref(&self.0[index])
UninitSlice::uninit_ref(&self.0[index])
}
}

impl IndexMut<$t> for UninitSlice {
#[inline]
fn index_mut(&mut self, index: $t) -> &mut UninitSlice {
UninitSlice::from_uninit_slice(&mut self.0[index])
UninitSlice::uninit(&mut self.0[index])
}
}
)*
Expand Down