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: FromBytes + IntoBytes> SharedMmioPointer<'_, T>

pub unsafe fn read_unsafe(&self) -> T

Performs an MMIO read and returns the value.

If T is exactly 1, 2, 4 or 8 bytes long then this will be a single operation. Otherwise it will be split into several, reading chunks as large as possible.

Safety

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

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

pub const unsafe fn child<U: ?Sized>( &self, regs: NonNull<U>, ) -> SharedMmioPointer<'a, 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 const 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<'a, T> SharedMmioPointer<'a, [T]>

pub fn split_some<const N: usize>( self, chosen: [usize; N], ) -> [UniqueMmioPointer<'a, T>; N]

Splits a UniqueMmioPointer to a slice into an array of UniqueMmioPointers, taking only the chosen indices.

Panics if chosen contains the same index more than once, or any index out of bounds.

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

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

pub fn get_range( &self, range: Range<usize>, ) -> Option<SharedMmioPointer<'_, [T]>>

Returns a SharedMmioPointer to a range of elements of this slice, or None if the range is out of bounds.

pub fn iter(&self) -> SharedMmioPointerIterator<'_, T>

Returns a new iterator of the items of the 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.

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

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

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

pub const fn as_slice(&self) -> SharedMmioPointer<'a, [T]>

Converts this array pointer to an equivalent slice pointer.

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

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

pub fn get_range( &self, range: Range<usize>, ) -> Option<SharedMmioPointer<'_, [T]>>

Returns a SharedMmioPointer to a range of elements of this array, or None if the range is out of bounds.

pub fn iter(&self) -> SharedMmioPointerIterator<'_, T>

Returns a new iterator of the items of the array.

Trait Implementations

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

fn clone(&self) -> Self

Returns a duplicate 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, const LEN: usize> From<SharedMmioPointer<'a, [T; LEN]>> for SharedMmioPointer<'a, [T]>

fn from(value: SharedMmioPointer<'a, [T; LEN]>) -> Self

Converts to this type from the input type.

impl<'a, T> From<SharedMmioPointer<'a, T>> for SharedMmioPointer<'a, [T]>

fn from(value: SharedMmioPointer<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T> From<SharedMmioPointer<'a, T>> for SharedMmioPointer<'a, [T; 1]>

fn from(value: SharedMmioPointer<'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<'a, T> IntoIterator for SharedMmioPointer<'a, [T]>

type Item = SharedMmioPointer<'a, T>

The type of the elements being iterated over.

type IntoIter = SharedMmioPointerIterator<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T, const LEN: usize> IntoIterator for SharedMmioPointer<'a, [T; LEN]>

type Item = SharedMmioPointer<'a, T>

The type of the elements being iterated over.

type IntoIter = SharedMmioPointerIterator<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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> Copy for SharedMmioPointer<'_, T>

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

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