Struct processes::memory::ProcessMemorySlice

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

Available on crate feature memory only.

A unowned slice of a buffer in the memory space of a process.

Implementations

impl<'a> ProcessMemorySlice<'a>

pub const unsafe fn from_raw_parts( ptr: *mut u8, len: usize, process: BorrowedProcess<'a> ) -> Self

Constructs a new slice from the given raw parts.

Safety

The caller must ensure that the designated region of memory

• is valid
• can be read using ReadProcessMemory
• can be written to using WriteProcessMemory
• will live as long as the slice is used

pub fn is_local(&self) -> bool

Returns whether this slice is in the memory space of the current process.

pub fn is_remote(&self) -> bool

Returns whether this slice is in the memory space of another process.

pub const fn process(&self) -> BorrowedProcess<'a>

Returns the process that owns the memory of this slice.

pub const fn len(&self) -> usize

Returns the length of the slice.

pub const fn is_empty(&self) -> bool

Returns whether the slice is empty.

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

Copies the contents of this slice to the given local buffer.

Panics

This function will panic if this slice is smaller than the given buffer.

pub unsafe fn read_buf<T: Copy>( &self, buf: &mut [T] ) -> Result<(), ProcessError>

Copies the contents of this slice to the given local buffer.

Safety

The caller must ensure that the designated region of memory contains valid instances of type T.

Panics

This function will panic if this slice is smaller than the given buffer.

pub unsafe fn read_vec<T: Copy>( &self, len: usize ) -> Result<Vec<T>, ProcessError>

Copies len instances of type T at the start of this slice into a newly allocated local Vec<T>.

Safety

The caller must ensure that the designated region of memory contains valid instances of type T.

Panics

This function will panic if this slice is smaller than the given buffer.

pub unsafe fn read_struct<T: Copy>(&self) -> Result<T, ProcessError>

Reads a value of type T from the start this slice and copies it into local memory space.

Panics

This function will panic if the size of the value exceeds this slice’s length.

Safety

The caller must ensure that the designated region of memory contains a valid instance of type T.

pub fn write(&self, buf: &[u8]) -> Result<(), ProcessError>

Copies the contents of the given local buffer to this slice.

Panics

This function will panic if the size of the local buffer exceeds this slice’s length.

pub fn write_buf<T: Copy>(&self, buf: &[T]) -> Result<(), ProcessError>

Copies the contents of the given local buffer to the memory region of this slice.

Panics

This function will panic if the size of the local buffer exceeds this slice’s length.

pub fn write_struct<T: ?Sized + Copy>(&self, s: &T) -> Result<(), ProcessError>

Writes a value of type T to the start of this slice.

Panics

This function will panic if the value’s size exceeds this buffer’s length.

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

Returns a pointer to the start of this slice.

Note

The returned pointer is only valid in the target process.

pub fn slice(&self, bounds: impl RangeBounds<usize>) -> Self

Returns a new slice spanning a subregion of this slice.

pub fn as_local_slice(&self) -> Option<&[u8]>

Constructs a new local slice spanning the memory of this slice. This function will return None for remote memory slices.

pub fn as_local_slice_mut(&mut self) -> Option<&mut [u8]>

Constructs a new mutable slice spanning the memory of this slice. This function will return None for remote memory slices.

pub fn flush_instruction_cache(&self) -> Result<(), ProcessError>

Flushes the CPU instruction cache for the whole slice. This may be necesary if the memory is used to store dynamically generated code. For details see FlushInstructionCache.

Trait Implementations

impl<'a> AsMut<ProcessMemorySlice<'a>> for ProcessMemoryBuffer<'a>

fn as_mut(&mut self) -> &mut ProcessMemorySlice<'a>

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

impl<'a> AsRef<ProcessMemorySlice<'a>> for ProcessMemoryBuffer<'a>

fn as_ref(&self) -> &ProcessMemorySlice<'a>

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

impl<'a> Clone for ProcessMemorySlice<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ProcessMemorySlice<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for ProcessMemorySlice<'a>