Struct process_vm_io::ProcessVirtualMemoryIO

#[non_exhaustive]
pub struct ProcessVirtualMemoryIO { /* private fields */ }

Input/Output object transferring data to/from the virtual memory contents of a particular process.

For better performance, consider doing buffered I/O based on the standard BufReader and BufWriter.

Implementations

impl ProcessVirtualMemoryIO

pub unsafe fn new(process_id: u32, initial_address: u64) -> Result<Self, Error>

Create a new object to perform input/output of data from/to the virtual memory contents of the process identified by process_id.

The initial virtual memory address where data transfers initially happen is specified by initial_address. Inquiring the system for the layout of the process address space can help specify this value. On Linux, the file /proc/[process_id]/maps can help with this.

Common errors

If the specified process does not exist, or this process does not have the right to send signals to the specified process, then an error is returned.

Safety

Writing to the virtual memory of a process is a potentially unsafe operation because it may introduce memory unsafety in that process, and may lead to unexpected states in that process. This is even more dangerous when the target process is the currently running process.

Running processes

Apart from the process identifier, there is no strong link between the specified process and this ProcessVirtualMemoryIO instance. If the specified process runs and terminates, then further I/O operations involving this instance may fail. If the process identifier of the dead process is reused by another process, then I/O may successfully continue with the new process, which might not be the desired behavior.

pub fn process_id(&self) -> u32

Return the process identifier of the target process.

Trait Implementations

impl Debug for ProcessVirtualMemoryIO

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

Formats the value using the given formatter.

impl Read for ProcessVirtualMemoryIO

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_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>

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_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

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

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

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

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

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> 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<'_>) -> Result<(), Error>

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

Read the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adaptor 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.

impl Seek for ProcessVirtualMemoryIO

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an address in the virtual memory address space of the associated process.

If the seek operation completed successfully, this method returns the new position from the start of the stream.

The target address need not be readable/writable or even mapped. Seeking beyond the address space size puts the cursor after the end of the address space.

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

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

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

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

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

Seeks relative to the current position.

impl Write for ProcessVirtualMemoryIO

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

Write a buffer into this writer, returning how many bytes were written.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

Like write, except that it writes from a slice of buffers.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

where Self: Sized,

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