Struct SharedMmioPointer

pub struct SharedMmioPointer<'a, T: ?Sized> { /* private fields */ }

A shared pointer to the registers of some MMIO device.

It is guaranteed to be valid but unlike UniqueMmioPointer may not be unique.

Implementations

impl<T> SharedMmioPointer<'_, T>

pub unsafe fn read_unsafe(&self) -> T

Performs an MMIO read of the entire T.

Safety

This field must be safe to perform an MMIO read from, and doing so must not cause any side-effects.

impl<T: ?Sized> SharedMmioPointer<'_, T>

pub unsafe fn child<U>(&self, regs: NonNull<U>) -> SharedMmioPointer<'_, U>

Creates a new SharedMmioPointer with the same lifetime as this one.

This is used internally by the field_shared! macro and shouldn’t be called directly.

Safety

regs must be a properly aligned and valid pointer to some MMIO address space of type T, within the allocation that self points to.

pub fn ptr(&self) -> *const T

Returns a raw const pointer to the MMIO registers.

impl<T: FromBytes + IntoBytes> SharedMmioPointer<'_, ReadPure<T>>

pub fn read(&self) -> T

Performs an MMIO read of the entire T.

impl<T: FromBytes + IntoBytes> SharedMmioPointer<'_, ReadPureWrite<T>>

pub fn read(&self) -> T

Performs an MMIO read of the entire T.

impl<T> SharedMmioPointer<'_, [T]>

pub fn get(&self, index: usize) -> Option<SharedMmioPointer<'_, T>>

Returns a SharedMmioPointer to an element of this slice, or None if the index is out of bounds.

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.

impl<T, const LEN: usize> SharedMmioPointer<'_, [T; LEN]>

pub fn split(&self) -> [SharedMmioPointer<'_, T>; LEN]

Splits a SharedMmioPointer to an array into an array of SharedMmioPointers.

pub fn get(&self, index: usize) -> Option<SharedMmioPointer<'_, T>>

Returns a SharedMmioPointer to an element of this array, or None if the index is out of bounds.

Trait Implementations

impl<T: ?Sized> Clone for SharedMmioPointer<'_, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized> Debug for SharedMmioPointer<'_, T>

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

Formats the value using the given formatter.

impl<'a, T: ?Sized> From<&'a T> for SharedMmioPointer<'a, T>

fn from(r: &'a T) -> Self

Converts to this type from the input type.

impl<'a, T: ?Sized> From<UniqueMmioPointer<'a, T>> for SharedMmioPointer<'a, T>

fn from(unique: UniqueMmioPointer<'a, T>) -> Self

Converts to this type from the input type.

impl<T: ?Sized> PartialEq for SharedMmioPointer<'_, T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: ?Sized> Eq for SharedMmioPointer<'_, T>

impl<T: ?Sized + Send + Sync> Send for SharedMmioPointer<'_, T>