Struct DmaAlignedRef 

pub struct DmaAlignedRef<'a, T>(/* private fields */)
where
    T: ?Sized;

Available on crate feature unstable only.

A shared reference to an InternalMemory object.

Unlike DmaAlignedMut, a DmaAlignedRef only allows reading the value and invalidating its cache lines (discarding the CPU-cached copy so a subsequent read observes data written by DMA). It can neither mutate the value nor write it back, so it can be obtained from a shared borrow and used to poll DMA-written, interior-mutable state (e.g. a descriptor’s ownership bit) without exclusive access.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Implementations

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

pub fn new(ptr: &'a T) -> Result<Self, DmaBufError>

Creates a new DmaAlignedRef from a shared reference, if it’s provably compatible.

In internal memory, the address and size of the value must be at least 4 byte aligned.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub const unsafe fn new_unchecked(ptr: &'a T) -> Self

Creates a new DmaAlignedRef from any shared reference.

Safety

The caller must ensure that the reference is properly aligned for the memory region it occupies and the cachelines occupied by the reference do not overlap with any other data that can be corrupted by a cacheline invalidation operation.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn into_inner(self) -> &'a T

Converts this object into a shared reference.

Trait Implementations

impl<'a, T> Debug for DmaAlignedRef<'a, T>

where T: ?Sized + Debug,

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

Formats the value using the given formatter.

impl<'a, T: ?Sized> Deref for DmaAlignedRef<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.