Struct pkbuffer::PtrBuffer

pub struct PtrBuffer { /* private fields */ }

A Buffer object backed by a pointer/size pair. Use this buffer type when accessing unowned memory or arbitrary allocated memory.

Implementations

impl PtrBuffer

pub fn new(pointer: *const u8, size: usize) -> Self

Create a new buffer object with a given pointer and size. Just make sure the pointer outlives the object and not the other way around.

pub fn set_pointer(&mut self, pointer: *const u8)

Set the new pointer of this buffer.

pub fn set_size(&mut self, size: usize)

Set the new size of this buffer.

pub fn sub_buffer(&self, offset: usize, size: usize) -> Result<Self, Error>

Create a new PtrBuffer object within the bounds of the current buffer.

pub fn split_at(&self, mid: usize) -> Result<(Self, Self), Error>

Split this buffer into two separate buffers at the given splitpoint mid.

Returns an Error::OutOfBounds error if this split goes out of bounds of the buffer.

Trait Implementations

impl AsMut<[u8]> for PtrBuffer

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for PtrBuffer

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Buffer for PtrBuffer

fn len(&self) -> usize

Get the length of this PtrBuffer object.

fn as_ptr(&self) -> *const u8

Get the PtrBuffer object as a pointer.

fn as_mut_ptr(&mut self) -> *mut u8

Get the PtrBuffer object as a mutable pointer.

fn as_slice(&self) -> &[u8]

Get the PtrBuffer object as a slice.

fn as_mut_slice(&mut self) -> &mut [u8]

Get the PtrBuffer object as a mutable slice.

fn eob(&self) -> *const u8

Get a pointer to the end of the buffer.

fn as_ptr_range(&self) -> Range<*const u8>

Get a pointer range of this buffer. See slice::as_ptr_range for more details.

fn as_mut_ptr_range(&mut self) -> Range<*mut u8>

Get a mutable pointer range of this buffer. See slice::as_mut_ptr_range for more details.

fn is_empty(&self) -> bool

Check whether or not this buffer is empty.

fn validate_ptr(&self, ptr: *const u8) -> bool

Validate that the given pointer object is within the range of this buffer.

fn offset_to_ptr(&self, offset: usize) -> Result<*const u8, Error>

Convert an offset to a u8 pointer.

fn offset_to_mut_ptr(&mut self, offset: usize) -> Result<*mut u8, Error>

Convert an offset to a mutable u8 pointer.

fn ptr_to_offset(&self, ptr: *const u8) -> Result<usize, Error>

Convert a pointer to an offset into the buffer.

fn ref_to_offset<T>(&self, data: &T) -> Result<usize, Error>

Convert a given reference to an object into an offset into the buffer.

fn slice_ref_to_offset<T>(&self, data: &[T]) -> Result<usize, Error>

Convert a given slice reference to an offset into the buffer.

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

Convert this buffer to a u8 Vec object.

fn swap(&mut self, a: usize, b: usize)

Swap two bytes at the given offsets. This panics if the offsets are out of bounds. See slice::swap for more details.

fn reverse(&mut self)

Reverse the buffer. See slice::reverse for more details.

fn iter(&self) -> BufferIter<'_>

Return an iterator object (BufferIter) into the buffer.

fn iter_mut(&mut self) -> BufferIterMut<'_>

Return a mutable iterator object (BufferIterMut) into the buffer.

fn save<P: AsRef<Path>>(&self, filename: P) -> Result<(), Error>

Save this buffer to disk.

fn get<I: SliceIndex<[u8]>>(&self, index: I) -> Option<&I::Output>

Get the given byte or range of bytes from the buffer. See slice::get for more details.

fn get_mut<I: SliceIndex<[u8]>>(&mut self, index: I) -> Option<&mut I::Output>

Get the given byte or range of bytes from the buffer as mutable. See slice::get_mut for more details.

fn get_ref<T: Castable>(&self, offset: usize) -> Result<&T, Error>

Get a reference to a given object within the buffer. Typically the main interface by which objects are retrieved.

unsafe fn get_ref_unaligned<T>(&self, offset: usize) -> Result<&T, Error>

Get a reference to a given object within the buffer, but in an unaligned way.

unsafe fn force_get_ref<T: Castable>(&self, offset: usize) -> Result<&T, Error>

Get a reference regardless of potential alignment issues.

fn get_mut_ref<T: Castable>(&mut self, offset: usize) -> Result<&mut T, Error>

Get a mutable reference to a given object within the buffer. See Buffer::get_ref.

unsafe fn get_mut_ref_unaligned<T>(
    &mut self,
    offset: usize
) -> Result<&mut T, Error>

Get a mutable reference to a given object within the buffer, but in an unaligned way.

unsafe fn force_get_mut_ref<T: Castable>(
    &mut self,
    offset: usize
) -> Result<&mut T, Error>

Get a mutable reference regardless of potential alignment issues.

fn make_mut_ref<T: Castable>(&mut self, data: &T) -> Result<&mut T, Error>

Convert a given reference to a mutable reference within the buffer.

unsafe fn make_mut_ref_unaligned<T>(
    &mut self,
    data: &T
) -> Result<&mut T, Error>

Convert a given reference to a mutable reference without alignment guarantees.

unsafe fn force_make_mut_ref<T: Castable>(
    &mut self,
    data: &T
) -> Result<&mut T, Error>

Convert an object to a mutable reference regardless of potential alignment issues.

fn get_slice_ref<T: Castable>(
    &self,
    offset: usize,
    size: usize
) -> Result<&[T], Error>

Gets a slice reference of type T at the given offset with the given size.

unsafe fn get_slice_ref_unaligned<T>(
    &self,
    offset: usize,
    size: usize
) -> Result<&[T], Error>

Gets a slice ref of type T at the given offset regardless of potential alignment issues.

unsafe fn force_get_slice_ref<T: Castable>(
    &self,
    offset: usize,
    size: usize
) -> Result<&[T], Error>

Get a slice reference regardless of potential alignment issues.

fn get_mut_slice_ref<T: Castable>(
    &mut self,
    offset: usize,
    size: usize
) -> Result<&mut [T], Error>

Gets a mutable slice reference of type T at the given offset with the given size. See Buffer::get_slice_ref.

unsafe fn get_mut_slice_ref_unaligned<T>(
    &mut self,
    offset: usize,
    size: usize
) -> Result<&mut [T], Error>

Gets a mutable slice reference of type T at the given offset with the given size, but without alignment checking. See Buffer::get_slice_ref_unaligned.

unsafe fn force_get_mut_slice_ref<T: Castable>(
    &mut self,
    offset: usize,
    size: usize
) -> Result<&mut [T], Error>

Get a mutable slice reference regardless of potential alignment issues.

fn make_mut_slice_ref<T: Castable>(
    &mut self,
    data: &[T]
) -> Result<&mut [T], Error>

Convert a given slice reference to a mutable slice reference within the buffer.

unsafe fn make_mut_slice_ref_unaligned<T>(
    &mut self,
    data: &[T]
) -> Result<&mut [T], Error>

Convert a given slice reference to a mutable slice reference without alignment guarantees.

unsafe fn force_make_mut_slice_ref<T: Castable>(
    &mut self,
    data: &[T]
) -> Result<&mut [T], Error>

Convert an object to a mutable reference regardless of potential alignment issues.

fn read(&self, offset: usize, size: usize) -> Result<&[u8], Error>

Read an arbitrary size amount of bytes from the given offset.

fn read_mut(&mut self, offset: usize, size: usize) -> Result<&mut [u8], Error>

Read an arbitrary size amount of bytes from the given offset, but mutable.

fn write<B: AsRef<[u8]>>(&mut self, offset: usize, data: B) -> Result<(), Error>

Write an arbitrary u8 slice to the given offset.

fn write_ref<T: Castable>(
    &mut self,
    offset: usize,
    data: &T
) -> Result<(), Error>

Write a given object of type T to the given buffer at the given offset.

fn write_slice_ref<T: Castable>(
    &mut self,
    offset: usize,
    data: &[T]
) -> Result<(), Error>

Write a given slice object of type T to the given buffer at the given offset.

fn start_with<B: AsRef<[u8]>>(&mut self, data: B) -> Result<(), Error>

Start the buffer object with the given byte data.

fn start_with_ref<T: Castable>(&mut self, data: &T) -> Result<(), Error>

Start the buffer with the given reference data.

fn start_with_slice_ref<T: Castable>(&mut self, data: &[T]) -> Result<(), Error>

Start the buffer with the given slice reference data.

fn end_with<B: AsRef<[u8]>>(&mut self, data: B) -> Result<(), Error>

End the buffer object with the given byte data.

fn end_with_ref<T: Castable>(&mut self, data: &T) -> Result<(), Error>

End the buffer with the given reference data.

fn end_with_slice_ref<T: Castable>(&mut self, data: &[T]) -> Result<(), Error>

End the buffer with the given slice reference data.

fn search<'a, B: AsRef<[u8]>>(
    &'a self,
    data: B
) -> Result<BufferSearchIter<'a>, Error>

Search for the given u8 slice data within the given buffer.

fn search_ref<'a, T: Castable>(
    &'a self,
    data: &T
) -> Result<BufferSearchIter<'a>, Error>

Search for the following reference of type T. This converts the object into a u8 slice. See Buffer::search.

fn search_slice_ref<'a, T: Castable>(
    &'a self,
    data: &[T]
) -> Result<BufferSearchIter<'a>, Error>

Search for the following slice reference of type T. This converts the slice into a u8 slice. See Buffer::search.

fn contains<B: AsRef<[u8]>>(&self, data: B) -> bool

Check if this buffer contains the following u8 slice sequence.

fn contains_ref<T: Castable>(&self, data: &T) -> Result<bool, Error>

Check if this buffer contains the following object of type T.

fn contains_slice_ref<T: Castable>(&self, data: &[T]) -> Result<bool, Error>

Check if this buffer contains the following slice of type T.

fn starts_with<B: AsRef<[u8]>>(&self, needle: B) -> bool

Check if this buffer starts with the byte sequence needle. See slice::starts_with.

fn ends_with<B: AsRef<[u8]>>(&self, needle: B) -> bool

Check if this buffer ends with the byte sequence needle. See slice::ends_with.

fn rotate_left(&mut self, mid: usize)

Rotate the buffer left at midpoint mid. See slice::rotate_left.

fn rotate_right(&mut self, mid: usize)

Rotate the buffer right at midpoint mid. See slice::rotate_right.

fn fill(&mut self, value: u8)

Fill the given buffer with the given value. See slice::fill.

fn fill_with<F>(&mut self, f: F) where
    F: FnMut() -> u8, 

Fill the given buffer with the given closure f. See slice::fill_with.

fn clone_from_data<B: AsRef<[u8]>>(&mut self, src: B)

Clone the given u8 slice data src into the given buffer.

fn copy_from_data<B: AsRef<[u8]>>(&mut self, src: B)

Copy the given u8 slice data src into the given buffer.

fn copy_within<R>(&mut self, src: R, dest: usize) where
    R: RangeBounds<usize>, 

Copy from within the given buffer. See slice::copy_within.

fn swap_with_data<B: AsMut<[u8]>>(&mut self, other: B)

Swap the data in this buffer with the given u8 slice reference.

fn is_ascii(&self) -> bool

Check if this buffer is ASCII. See slice::is_ascii.

fn eq_ignore_ascii_case(&self, other: &[u8]) -> bool

Check if this buffer is equal while ignoring case of letters. See slice::eq_ignore_ascii_case.

fn make_ascii_uppercase(&mut self)

Make this buffer ASCII uppercase. See slice::make_ascii_uppercase.

fn make_ascii_lowercase(&mut self)

Make this buffer ASCII lowercase. See slice::make_ascii_lowercase.

fn sort(&mut self)

Sort this buffer. See slice::sort.

fn sort_by<F>(&mut self, compare: F) where
    F: FnMut(&u8, &u8) -> Ordering, 

Sort by the given closure comparing each individual byte. See slice::sort_by.

fn sort_by_key<K, F>(&mut self, f: F) where
    F: FnMut(&u8) -> K,
    K: Ord, 

Sorts the slice with a key extraction function. See slice::sort_by_key.

fn repeat(&self, n: usize) -> Vec<u8>

Creates a new Buffer object by repeating the current buffer n times. See slice::repeat.

impl Clone for PtrBuffer

fn clone(&self) -> PtrBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PtrBuffer

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

Formats the value using the given formatter.

impl Hash for PtrBuffer

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<Idx: SliceIndex<[u8]>> Index<Idx> for PtrBuffer

type Output = Idx::Output

The returned type after indexing.

fn index(&self, index: Idx) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<Idx: SliceIndex<[u8]>> IndexMut<Idx> for PtrBuffer

fn index_mut(&mut self, index: Idx) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IntoIterator for PtrBuffer

type Item = u8

The type of the elements being iterated over.

type IntoIter = IntoIter<Self::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const N: usize> PartialEq<[u8; N]> for PtrBuffer

fn eq(&self, other: &[u8; N]) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<[u8]> for PtrBuffer

fn eq(&self, other: &[u8]) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Buffer> PartialEq<T> for PtrBuffer

fn eq(&self, other: &T) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Vec<u8, Global>> for PtrBuffer

fn eq(&self, other: &Vec<u8>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Copy for PtrBuffer

impl Eq for PtrBuffer

impl StructuralEq for PtrBuffer