Skip to main content

PkCommandConfig

Struct PkCommandConfig 

Source
pub struct PkCommandConfig { /* private fields */ }
Expand description

Configuration for the PkCommand state machine.

Use this struct to define timeout durations and packet size limits according to your transport layer’s constraints (e.g., HID, Serial, etc.).

Implementations§

Source§

impl PkCommandConfig

Source

pub fn default(packet_limit: u64) -> Self

Creates a PkCommandConfig with default (as recommended in the specification file) timeout values.

§Default timeouts
  • ACK timeout: 100ms
  • Inter command timeout: 500ms
  • AWAIT interval: 300ms
§Arguments
  • packet_limit: The maximum packet size (MTU) of the underlying transport (e.g., 64 for HID).
§Returns

A PkCommandConfig instance with default timeouts and the specified packet limit.

§Note

This is not an implementation of Default trait because packet_limit must be specified.

Source

pub fn new( ack_timeout: u64, inter_command_timeout: u64, await_interval: u64, packet_limit: u64, ) -> Self

Creates a new PkCommandConfig with custom timing and packet limit.

§Arguments
  • ack_timeout: Timeout for ACKs in milliseconds.
  • inter_command_timeout: Timeout between commands in milliseconds.
  • await_interval: Interval for sending AWAIT keep-alives in milliseconds.
  • packet_limit: Maximum length of a single packet in bytes.
§Note

To avoid undesirable behavior, you should ensure that the timeout values on both sides (Host and Device) are exactly the same.

Trait Implementations§

Source§

impl Clone for PkCommandConfig

Source§

fn clone(&self) -> PkCommandConfig

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

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.