Skip to main content

CpuRetentionMemory

esp_hal::rtc_cntl

Struct CpuRetentionMemory

pub struct CpuRetentionMemory { /* private fields */ }

Available on crate feature unstable only.

Expand description

Memory that light sleep uses to retain the CPU domain.

The sleep path writes this memory while the CPU domain has no power, so the buffer gives no way to read or write its contents through safe Rust.

Install the buffer with LowPower::install_cpu_retention_memory. The buffer must live in internal RAM that stays powered across light sleep. The #[ram(reclaimed)] attribute places a static inside the reachable range on chips that use the retention DMA.

§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.

Auto Trait Implementations§

impl !Freeze for CpuRetentionMemory

impl !RefUnwindSafe for CpuRetentionMemory

impl !Sync for CpuRetentionMemory

impl Send for CpuRetentionMemory

impl Unpin for CpuRetentionMemory

impl UnsafeUnpin for CpuRetentionMemory

impl UnwindSafe for CpuRetentionMemory

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> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> 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> Same for T

type Output = T

Should always be Self

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.