Skip to main content

CpuFrequencyLock

Struct CpuFrequencyLock 

Source
#[non_exhaustive]
pub struct CpuFrequencyLock;
Available on crate feature unstable only.
Expand description

A guard that keeps the CPU clock unchanged while the CPU waits for an interrupt.

When the ESP_HAL_CONFIG_IDLE_FREQUENCY_SCALING option is enabled, wait_for_interrupt switches the CPU clock to XTAL_CLK until an interrupt occurs. The CPU clock returns to its configured source before the interrupt handler runs, which increases the interrupt latency. While at least one CpuFrequencyLock is held, the CPU clock does not change. The lock is released when the guard is dropped.

When the option is disabled, or the chip does not support it, CpuFrequencyLock does nothing.

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

Source§

impl CpuFrequencyLock

Source

pub fn new() -> Self

Acquires a CPU frequency lock, which is released when it is dropped.

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

Source

pub fn acquire()

Acquires a CPU frequency lock.

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

Source

pub fn release()

Releases a CPU frequency lock.

Must only be called to release a lock acquired via Self::acquire.

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

Trait Implementations§

Source§

impl Clone for CpuFrequencyLock

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

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable)§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CpuFrequencyLock

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CpuFrequencyLock

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

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for CpuFrequencyLock

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl Forget for CpuFrequencyLock

§

impl Freeze for CpuFrequencyLock

§

impl Move for CpuFrequencyLock

§

impl RefUnwindSafe for CpuFrequencyLock

§

impl Send for CpuFrequencyLock

§

impl Sync for CpuFrequencyLock

§

impl Unpin for CpuFrequencyLock

§

impl UnsafeUnpin for CpuFrequencyLock

§

impl UnwindSafe for CpuFrequencyLock

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> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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.

Source§

impl<T> Same for T

Source§

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.