Struct memflow::mem::memory_view::cursor::MemoryCursor

pub struct MemoryCursor<T> { /* private fields */ }

MemoryCursor implments a Cursor around the MemoryView trait.

The cursor provides the Read, Write and Seek traits for the underlying MemoryView object.

Examples:

use std::io::{self, Read, Write, Seek};

use memflow::dummy::{DummyOs, DummyMemory};
use memflow::types::size;
use memflow::mem::{DirectTranslate, VirtualDma, MemoryCursor};
use memflow::architecture::x86::x64;

fn main() -> io::Result<()> {
    // setup a pseudo virtual memory reader
    let phys_mem = DummyMemory::new(size::mb(16));
    let mut os = DummyOs::new(phys_mem);
    let (dtb, virt_base) = os.alloc_dtb(size::mb(8), &[]);
    let phys_mem = os.into_inner();
    let translator = x64::new_translator(dtb);

    let virt_mem = VirtualDma::new(phys_mem, x64::ARCH, translator);

    // create the actual cursor and seek it to the dummy virt_base
    let mut cursor = MemoryCursor::new(virt_mem);
    cursor.seek(io::SeekFrom::Start(virt_base.to_umem() as u64))?;

    // read up to 10 bytes
    let mut buffer = [0; 10];
    cursor.read(&mut buffer)?;

    // write the previously read 10 bytes again
    cursor.seek(io::SeekFrom::Start(virt_base.to_umem() as u64))?;
    cursor.write(&buffer)?;

    Ok(())
}

Implementations

impl<T: MemoryView> MemoryCursor<T>

pub fn new(mem: T) -> Self

Creates a new MemoryCursor by wrapping around a MemoryView object.

Cursor initial position is 0.

Examples:

Borrowing a MemoryView object:

use memflow::dummy::DummyMemory;
use memflow::types::size;
use memflow::mem::MemoryCursor;

let mut virt_mem = VirtualDma::new(phys_mem, x64::ARCH, translator);
let mut cursor = MemoryCursor::new(virt_mem);

Taking (temporary) ownership of a MemoryView object:

use memflow::dummy::DummyMemory;
use memflow::types::size;
use memflow::mem::MemoryCursor;

let virt_mem = VirtualDma::new(phys_mem, x64::ARCH, translator);
let mut cursor = MemoryCursor::new(virt_mem);

pub fn at(mem: T, address: Address) -> Self

Creates a new MemoryCursor by wrapping around a MemoryView object at the desired starting position.

Cursor initial position is * address.

Examples:

Borrowing a MemoryView object:

use memflow::dummy::DummyMemory;
use memflow::types::size;
use memflow::mem::MemoryCursor;

let mut virt_mem = VirtualDma::new(phys_mem, x64::ARCH, translator);
let mut cursor = MemoryCursor::at(virt_mem, 0x1000.into());

Taking (temporary) ownership of a MemoryView object:

use memflow::dummy::DummyMemory;
use memflow::types::size;
use memflow::mem::MemoryCursor;

let virt_mem = VirtualDma::new(phys_mem, x64::ARCH, translator);
let mut cursor = MemoryCursor::at(virt_mem, 0x1000.into());

pub fn into_inner(self) -> T

Consumes this cursor, returning the underlying MemoryView object.

Examples

use memflow::dummy::DummyMemory;
use memflow::types::size;
use memflow::mem::MemoryCursor;

let mut cursor = MemoryCursor::new(VirtualDma::new(phys_mem, x64::ARCH, translator));

let phys_mem = cursor.into_inner();

pub fn get_ref(&self) -> &T

Gets a reference to the underlying MemoryView object in this cursor.

Examples

use memflow::dummy::DummyMemory;
use memflow::types::size;
use memflow::mem::MemoryCursor;

let mut cursor = MemoryCursor::new(VirtualDma::new(phys_mem, x64::ARCH, translator));

let reference = cursor.get_ref();

pub fn get_mut(&mut self) -> &mut T

Gets a mutable reference to the underlying MemoryView object in this cursor.

Examples

use memflow::dummy::DummyMemory;
use memflow::types::size;
use memflow::mem::MemoryCursor;

let mut cursor = MemoryCursor::new(VirtualDma::new(phys_mem, x64::ARCH, translator));

let reference = cursor.get_mut();

pub fn address(&self) -> Address

Returns the current address of this cursor.

Examples

use std::io::{Seek, SeekFrom};

use memflow::dummy::DummyMemory;
use memflow::types::{Address, size};
use memflow::mem::MemoryCursor;

let mut cursor = MemoryCursor::new(VirtualDma::new(phys_mem, x64::ARCH, translator));

assert_eq!(cursor.address(), Address::NULL);

cursor.seek(SeekFrom::Current(2)).unwrap();
assert_eq!(cursor.address(), Address::from(2));

cursor.seek(SeekFrom::Current(-1)).unwrap();
assert_eq!(cursor.address(), Address::from(1));

pub fn set_address(&mut self, address: Address)

Sets the address of this cursor.

Examples

use memflow::dummy::DummyMemory;
use memflow::types::{Address, size};
use memflow::mem::MemoryCursor;

let mut cursor = MemoryCursor::new(VirtualDma::new(phys_mem, x64::ARCH, translator));

assert_eq!(cursor.address(), Address::NULL);

cursor.set_address(Address::from(2));
assert_eq!(cursor.address(), Address::from(2));

cursor.set_address(Address::from(4));
assert_eq!(cursor.address(), Address::from(4));

Trait Implementations

impl<T: MemoryView> Read for MemoryCursor<T>

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, 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_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<T: MemoryView> Seek for MemoryCursor<T>

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

Seek to an offset, in bytes, in a stream.

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<T: MemoryView> Write for MemoryCursor<T>

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

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

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

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

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

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

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.