Skip to main content

EmbassyInstant

Struct EmbassyInstant 

Source
pub struct EmbassyInstant(/* private fields */);
Available on crate feature embassy-time only.
Expand description

A PkInstant adapter for embassy_time::Instant.

This type bridges the PK Command timing abstraction with the embassy-time crate, enabling timeout handling in no_std/embedded environments that use Embassy.

§Availability

Enabled when the embassy feature is active (it also enables embassy-time).

§Why this wrapper exists

embassy_time::Instant is tied to embassy_time::Duration, while PK Command uses core::time::Duration. These durations can be converted, but their types are not directly compatible with the PkCommand signature, so a newtype adapter keeps the API consistent without large generic changes.

§Notes

  • Implements Add<Duration> with millisecond precision.
  • elapsed() guards against clock rollback by returning 0 if the current instant is earlier than the stored instant.

§Example

use pk_command::{
    EmbassyInstant, PkCommand, PkCommandConfig, PkHashmapMethod, PkHashmapVariable,
};

// embassy_timer::Instant must be constructed within an Embassy context
// otherwise the code would not compile.
#[embassy_executor::task]
async fn example() {
    let pk = PkCommand::<_, _, EmbassyInstant>::new(
        PkCommandConfig::default(64),
        PkHashmapVariable::new(vec![]),
        PkHashmapMethod::new(vec![]),
    );
}

§See also

To use PK Command within an Embassy context, you might also want to have a look at embassy_adapter.

Trait Implementations§

Source§

impl Add<Duration> for EmbassyInstant

Source§

type Output = EmbassyInstant

The resulting type after applying the + operator.
Source§

fn add(self, rhs: Duration) -> Self::Output

Performs the + operation. Read more
Source§

impl Clone for EmbassyInstant

Source§

fn clone(&self) -> EmbassyInstant

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl From<Instant> for EmbassyInstant

Source§

fn from(inst: Instant) -> Self

Converts to this type from the input type.
Source§

impl Ord for EmbassyInstant

Source§

fn cmp(&self, other: &EmbassyInstant) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for EmbassyInstant

Source§

fn eq(&self, other: &EmbassyInstant) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for EmbassyInstant

Source§

fn partial_cmp(&self, other: &EmbassyInstant) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl PkInstant for EmbassyInstant

Source§

fn now() -> Self

Returns the current instant.
Source§

fn elapsed(&self) -> Duration

Returns the duration elapsed since this instant.
Source§

impl Copy for EmbassyInstant

Source§

impl Eq for EmbassyInstant

Source§

impl StructuralPartialEq for EmbassyInstant

Auto Trait Implementations§

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.