Crate wasefire_protocol 

Wasefire platform protocol.

This crate defines a high-level protocol between a host and a device. The host initiates requests and the device responds. Requests and responses use the same Api but with a different type parameter: Api<Request> and Api<Response> respectively. However, while the host sends an Api<Request>, the device responds with an ApiResult<T> where T is the service of the request.

This high-level protocol is eventually wrapped in a lower-level protocol for a given transport, for example USB. The host should provide enough time for the device to respond, but should eventually move on in case no response will ever come, for example when the device is reset before sending the response. Reciprocally, the device should accept a new request from the host and cancel the request it was processing if any.

Modules

applet

bundlehost

common

platform

transfer

Protocol to transfer data from the host to the device.

Structs

Devicehost

Connection with a cached API version.

Versions_descriptor or host

Enums

Api

Protocol API parametric over the message direction.

ApiResult

ApiVersion

Returns the device API version.

AppletExitStatus

Returns the exit status of an applet, if not running.

AppletInstall2

Installs or uninstalls an applet.

AppletMetadata0

Returns the metadata of an applet.

AppletReboot

Reboots an applet.

AppletRequest

Sends a request to an applet.

AppletResponse

Reads a response from an applet.

AppletTunnel

Starts a direct tunnel with an applet.

PlatformClearStore

Clears the store for the platform and all applets.

PlatformInfo3

Returns information about the platform.

PlatformLock

Locks a platform until reboot.

PlatformReboot

Reboots the platform.

PlatformUpdate

Updates the platform.

PlatformVendor

Calls a vendor-specific platform command.

Request

_AppletInstall0host

(deprecated) Installs an applet.

_AppletInstall1host

(deprecated) Installs or uninstalls an applet.

_AppletUninstall0host

(deprecated) Uninstalls an applet.

_PlatformInfo0host

(deprecated) Returns platform information (e.g. serial and version).

_PlatformInfo1host

(deprecated) Returns platform information.

_PlatformInfo2host

(deprecated) Returns information about the platform.

_PlatformUpdate0host

(deprecated) Updates the platform.

_PlatformUpdateMetadatahost

(deprecated) Returns the metadata for platform update.

Constants

VERSION

Device API version (or maximum supported device API version for host).

Traits

Connectionhost

ConnectionExthost

Service

Service description.

Type Aliases

DynDevicehost

DynFuturehost