Struct PtrByteSlice 

pub struct PtrByteSlice<'a> { /* private fields */ }

A read-only view of a raw pointer byte slice, providing a safe API.

Implementations

impl<'a> PtrByteSlice<'a>

pub unsafe fn new(slice: *const [u8]) -> Self

Creates a new PtrByteSlice from a raw pointer to a byte slice.

Safety

The caller must ensure that slice is valid for reads for the lifetime 'a.

pub fn len(&self) -> usize

Returns the length of the slice in bytes.

pub fn is_empty(&self) -> bool

Returns true if the slice has a length of 0.

pub fn read<T: Copy + FromBytes>(&self) -> Option<T>

Reads a copy of a value of type T from the start of the slice.

The read is performed unaligned, so the slice does not need to be aligned to T.

pub fn copy_to_slice(&self, dest: &mut [u8])

Copies the contents of this slice into a safe Rust mutable slice.

Panics

Panics if dest is smaller than self.len().

pub fn subslice(&self, range: Range<usize>) -> Self

Returns a subslice of this pointer slice.

Panics

Panics if the range is out of bounds.

pub fn split_at(self, mid: usize) -> (Self, Self)

Splits the slice into two at the given index.

Panics

Panics if mid is out of bounds.

pub fn as_raw_slice_ptr(&self) -> *const [u8]

Returns the raw pointer to the slice.

pub fn as_ptr(&self) -> *const u8

Returns a raw pointer to the start of the slice.

pub fn to_vec(&self) -> Vec<u8>

Allocates a new heap Vector and copies the contents into it. Bypasses zero-initialization using raw pointer copies.

pub fn append_to(&self, vec: &mut Vec<u8>)

Appends the contents of this slice to the given vector, expanding its capacity if needed. Bypasses zero-initialization using raw pointer copies.

pub fn chunks<T: Copy + FromBytes>(&self) -> Chunks<'_, T>

Returns an iterator over read-only chunks of type T.

Panics

Panics if the slice is not aligned to T or if its length in bytes is not a multiple of size_of::<T>().

Trait Implementations

impl<'a> Clone for PtrByteSlice<'a>

fn clone(&self) -> PtrByteSlice<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for PtrByteSlice<'a>

impl<'a> Debug for PtrByteSlice<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> From<&'a Vec<u8>> for PtrByteSlice<'a>

fn from(vec: &'a Vec<u8>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a [u8]> for PtrByteSlice<'a>

fn from(slice: &'a [u8]) -> Self

Converts to this type from the input type.

impl<'a> From<MutPtrByteSlice<'a>> for PtrByteSlice<'a>

fn from(slice: MutPtrByteSlice<'a>) -> Self

Converts to this type from the input type.

impl Read for PtrByteSlice<'_>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>

Reads the exact number of bytes required to fill buf.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

Reads all bytes until EOF in this source, placing them into buf.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_, u8>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact( &mut self, cursor: BorrowedCursor<'_, u8>, ) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

🔬This is a nightly-only experimental API. (read_array)

Read and return a fixed array of bytes from this source.

fn read_le<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

🔬This is a nightly-only experimental API. (read_le)

Read and return a type (e.g. an integer) in little-endian order.

fn read_be<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

🔬This is a nightly-only experimental API. (read_le)

Read and return a type (e.g. an integer) in big-endian order.

impl Send for PtrByteSlice<'_>

impl Sync for PtrByteSlice<'_>