Struct IoMem &nbsp; Copy item path

impl<SecuritySensitivity> IoMem<SecuritySensitivity>

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

Slices the IoMem, returning another IoMem representing the subslice.

§Panics

This method will panic if the range is empty or out of bounds.

pub fn cache_policy(&self) -> CachePolicy

Returns the cache policy of this IoMem.

impl IoMem<Insensitive>

pub fn acquire(range: Range<Paddr>) -> Result<IoMem<Insensitive>>

Acquires an IoMem instance for the given range.

The I/O memory cache policy is set to uncacheable by default.

pub fn acquire_with_cache_policy( range: Range<Paddr>, cache_policy: CachePolicy, ) -> Result<IoMem<Insensitive>>

Acquires an IoMem instance for the given range with the specified cache policy.

pub fn read_fallible( &self, offset: usize, writer: &mut VmWriter<'_>, ) -> Result<usize, (Error, usize)>

Reads from MMIO into fallible memory and returns the copied length.

This method performs the same low-level copy primitive as VmIo::read, but exposes partial progress instead of enforcing no-short-read semantics.

pub fn write_fallible( &self, offset: usize, reader: &mut VmReader<'_>, ) -> Result<usize, (Error, usize)>

Writes from fallible memory to MMIO and returns the copied length.

This method performs the same low-level copy primitive as VmIo::write, but exposes partial progress instead of enforcing no-short-write semantics.

Trait Implementations§

impl<SecuritySensitivity: Clone> Clone for IoMem<SecuritySensitivity>

fn clone(&self) -> IoMem<SecuritySensitivity>

Returns a duplicate of the value. Read more

1.0.0§

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

Performs copy-assignment from source. Read more

impl<SecuritySensitivity: Debug> Debug for IoMem<SecuritySensitivity>

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

Formats the value using the given formatter. Read more

impl<SecuritySensitivity> Drop for IoMem<SecuritySensitivity>

fn drop(&mut self)

Executes the destructor for this type. Read more

impl<SecuritySensitivity> HasPaddr for IoMem<SecuritySensitivity>

fn paddr(&self) -> Paddr

Returns the start physical address of the memory object.

impl<SecuritySensitivity> HasSize for IoMem<SecuritySensitivity>

fn size(&self) -> usize

Returns the size of the memory object in bytes.

impl VmIo for &IoMem<Insensitive>

fn read(&self, offset: usize, writer: &mut VmWriter<'_>) -> Result<()>

Reads requested data at a specified offset into a given VmWriter. Read more

fn write(&self, offset: usize, reader: &mut VmReader<'_>) -> Result<()>

Writes all data from a given VmReader at a specified offset. Read more

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

Reads a specified number of bytes at a specified offset into a given buffer. Read more

fn read_val<T: Pod>(&self, offset: usize) -> Result<T>

Reads a value of a specified type at a specified offset.

fn read_slice<T: Pod>(&self, offset: usize, slice: &mut [T]) -> Result<()>

Reads a slice of a specified type at a specified offset. Read more

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

Writes a specified number of bytes from a given buffer at a specified offset. Read more

fn write_val<T: Pod>(&self, offset: usize, new_val: &T) -> Result<()>

Writes a value of a specified type at a specified offset.

fn write_slice<T: Pod>(&self, offset: usize, slice: &[T]) -> Result<()>

Writes a slice of a specified type at a specified offset. Read more

impl VmIo for &mut IoMem<Insensitive>

fn read(&self, offset: usize, writer: &mut VmWriter<'_>) -> Result<()>

Reads requested data at a specified offset into a given VmWriter. Read more

fn write(&self, offset: usize, reader: &mut VmReader<'_>) -> Result<()>

Writes all data from a given VmReader at a specified offset. Read more

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

Reads a specified number of bytes at a specified offset into a given buffer. Read more

fn read_val<T: Pod>(&self, offset: usize) -> Result<T>

Reads a value of a specified type at a specified offset.

fn read_slice<T: Pod>(&self, offset: usize, slice: &mut [T]) -> Result<()>

Reads a slice of a specified type at a specified offset. Read more

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

Writes a specified number of bytes from a given buffer at a specified offset. Read more

fn write_val<T: Pod>(&self, offset: usize, new_val: &T) -> Result<()>

Writes a value of a specified type at a specified offset.

fn write_slice<T: Pod>(&self, offset: usize, slice: &[T]) -> Result<()>

Writes a slice of a specified type at a specified offset. Read more

impl VmIo for IoMem<Insensitive>

fn read(&self, offset: usize, writer: &mut VmWriter<'_>) -> Result<()>

Reads requested data at a specified offset into a given VmWriter. Read more

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

Reads a specified number of bytes at a specified offset into a given buffer. Read more

fn write(&self, offset: usize, reader: &mut VmReader<'_>) -> Result<()>

Writes all data from a given VmReader at a specified offset. Read more

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

Writes a specified number of bytes from a given buffer at a specified offset. Read more

fn read_val<T: Pod>(&self, offset: usize) -> Result<T>

Reads a value of a specified type at a specified offset.

fn read_slice<T: Pod>(&self, offset: usize, slice: &mut [T]) -> Result<()>

Reads a slice of a specified type at a specified offset. Read more

fn write_val<T: Pod>(&self, offset: usize, new_val: &T) -> Result<()>

Writes a value of a specified type at a specified offset.

fn write_slice<T: Pod>(&self, offset: usize, slice: &[T]) -> Result<()>

Writes a slice of a specified type at a specified offset. Read more

impl VmIoFill for &IoMem<Insensitive>

fn fill_zeros(&self, offset: usize, len: usize) -> Result<(), (Error, usize)>

Writes len zeros at a specified offset. Read more

impl VmIoFill for &mut IoMem<Insensitive>

fn fill_zeros(&self, offset: usize, len: usize) -> Result<(), (Error, usize)>

Writes len zeros at a specified offset. Read more

impl VmIoFill for IoMem<Insensitive>

fn fill_zeros(&self, offset: usize, len: usize) -> Result<(), (Error, usize)>

Writes len zeros at a specified offset. Read more

impl VmIoOnce for &IoMem<Insensitive>

fn read_once<T: PodOnce>(&self, offset: usize) -> Result<T>

Reads a value of the PodOnce type at the specified offset using one non-tearing memory load. Read more

fn write_once<T: PodOnce>(&self, offset: usize, value: &T) -> Result<()>

Writes a value of the PodOnce type at the specified offset using one non-tearing memory store. Read more

impl VmIoOnce for &mut IoMem<Insensitive>

fn read_once<T: PodOnce>(&self, offset: usize) -> Result<T>

Reads a value of the PodOnce type at the specified offset using one non-tearing memory load. Read more

fn write_once<T: PodOnce>(&self, offset: usize, value: &T) -> Result<()>

Writes a value of the PodOnce type at the specified offset using one non-tearing memory store. Read more

impl VmIoOnce for IoMem<Insensitive>

fn read_once<T: PodOnce>(&self, offset: usize) -> Result<T>

Reads a value of the PodOnce type at the specified offset using one non-tearing memory load. Read more

fn write_once<T: PodOnce>(&self, offset: usize, value: &T) -> Result<()>

Writes a value of the PodOnce type at the specified offset using one non-tearing memory store. Read more

Auto Trait Implementations§

impl<SecuritySensitivity> Freeze for IoMem<SecuritySensitivity>

impl<SecuritySensitivity> RefUnwindSafe for IoMem<SecuritySensitivity>
where SecuritySensitivity: RefUnwindSafe,

impl<SecuritySensitivity> Send for IoMem<SecuritySensitivity>
where SecuritySensitivity: Send,

impl<SecuritySensitivity> Sync for IoMem<SecuritySensitivity>
where SecuritySensitivity: Sync,

impl<SecuritySensitivity> Unpin for IoMem<SecuritySensitivity>
where SecuritySensitivity: Unpin,

impl<SecuritySensitivity> UnwindSafe for IoMem<SecuritySensitivity>
where SecuritySensitivity: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> HasPaddrRange for T
where T: HasPaddr + HasSize,

fn end_paddr(&self) -> usize

Returns the end physical address of the memory object.

fn paddr_range(&self) -> Range<usize>

Returns the physical address range of the memory object.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointee for T

type Metadata = ()

The metadata type for pointers and references to this type.

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.