DmaSubSlice

Struct DmaSubSlice 

Source
pub struct DmaSubSlice<'a, T: ImmutableFromIntoBytes> { /* private fields */ }
Expand description

An immutable buffer that can be safely used for read-only DMA operations, created from a SubSlice describing an active range in a larger buffer.

Creating a DmaSubSlice over a SubSlice ensures that all prior Rust writes to the active region of this slice are observable by any DMA operations initiated through an MMIO write operation, where that MMIO write is performed after constructing the DmaSubSlice.

For this guarantee to hold, the DmaSubSlice struct must exist for the duration of the entire DMA operation, until the Rust program has observed that the operation is complete (such as by reading a status bit in memory or an MMIO register).

DmaSubSlice wraps an immutable, shared Rust slice reference. As such, its contents must not be modified by the DMA operation. For a DMA operation that may write to the supplied buffer, use DmaSubSliceMut instead.

Implementations§

Source§

impl<'a, T: ImmutableFromIntoBytes> DmaSubSlice<'a, T>

Source

pub fn new( sub_slice: SubSlice<'_, T>, fence: impl DmaFence, ) -> DmaSubSlice<'_, T>

Create a DmaSubSlice from a shared, immutable Rust slice.

This function uses the supplied fence object to ensure that all prior writes to slice are exposed to any DMA operations initiated by an MMIO read or write operation after this function returns, and which finish before the resulting DmaSubSlice is dropped.

Source

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

Returns the pointer to the first element of the currently accessible portion of the wrapped SubSlice.

Source

pub fn len(&self) -> usize

Returns the length of the currently accessible range of the wrapped SubSlice.

Source

pub fn as_sub_slice(&self) -> SubSlice<'a, T>

Retrieve the wrapped SubSlice.

Trait Implementations§

Source§

impl<'a, T: Debug + ImmutableFromIntoBytes> Debug for DmaSubSlice<'a, T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, T> Freeze for DmaSubSlice<'a, T>

§

impl<'a, T> RefUnwindSafe for DmaSubSlice<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for DmaSubSlice<'a, T>
where T: Sync,

§

impl<'a, T> Sync for DmaSubSlice<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for DmaSubSlice<'a, T>

§

impl<'a, T> UnwindSafe for DmaSubSlice<'a, T>
where T: RefUnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.