Enum wasefire_protocol::Api

#[non_exhaustive]
pub enum Api<'a, T: Direction> {
    ApiVersion(T::Type<'a, ApiVersion>),
    AppletRequest(T::Type<'a, AppletRequest>),
    AppletResponse(T::Type<'a, AppletResponse>),
    PlatformReboot(T::Type<'a, PlatformReboot>),
    AppletTunnel(T::Type<'a, AppletTunnel>),
    PlatformInfo(T::Type<'a, PlatformInfo>),
    PlatformVendor(T::Type<'a, PlatformVendor>),
}

Protocol API parametric over the message direction.

Variants gated by the full feature are deprecated. They won’t be used by new devices. However, to support older devices, the host must be able to use them.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ApiVersion(T::Type<'a, ApiVersion>)

Returns the device API version.

AppletRequest(T::Type<'a, AppletRequest>)

Sends a request to an applet.

AppletResponse(T::Type<'a, AppletResponse>)

Reads a response from an applet.

PlatformReboot(T::Type<'a, PlatformReboot>)

Reboots the platform.

AppletTunnel(T::Type<'a, AppletTunnel>)

Starts a direct tunnel with an applet.

PlatformInfo(T::Type<'a, PlatformInfo>)

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

PlatformVendor(T::Type<'a, PlatformVendor>)

Calls a vendor-specific platform command.

Implementations

impl<'a> Api<'a, Request>

pub fn encode(&self) -> Result<Box<[u8]>, Error>

Available on crate feature host only.

pub fn decode(data: &'a [u8]) -> Result<Self, Error>

Available on crate feature device only.

Trait Implementations

impl<'a, T: Debug + Direction> Debug for Api<'a, T>

where T::Type<'a, ApiVersion>: Debug, T::Type<'a, AppletRequest>: Debug, T::Type<'a, AppletResponse>: Debug, T::Type<'a, PlatformReboot>: Debug, T::Type<'a, AppletTunnel>: Debug, T::Type<'a, PlatformInfo>: Debug, T::Type<'a, PlatformVendor>: Debug,

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

Formats the value using the given formatter.

impl<'a, T: Direction> Wire<'a> for Api<'a, T>

type Type<'_a> = Api<'_a, T>

fn encode(&self, writer: &mut Writer<'a>) -> Result<()>

fn decode(reader: &mut Reader<'a>) -> Result<Self>