Struct CommandReturn

pub struct CommandReturn(/* private fields */);

Possible return values of a command driver method, as specified in TRD104.

This is just a wrapper around SyscallReturn since a command driver method may only return primitive integer types as payload.

It is important for this wrapper to only be constructable over variants of SyscallReturn that are deemed safe for a capsule to construct and return to an application (e.g. not SubscribeSuccess). This means that the inner value must remain private.

Implementations

impl CommandReturn

pub fn failure(rc: ErrorCode) -> Self

Command error

pub fn failure_u32(rc: ErrorCode, data0: u32) -> Self

Command error with an additional 32-bit data field

pub fn failure_u32_u32(rc: ErrorCode, data0: u32, data1: u32) -> Self

Command error with two additional 32-bit data fields

pub fn failure_u64(rc: ErrorCode, data0: u64) -> Self

Command error with an additional 64-bit data field

pub fn success() -> Self

Successful command

pub fn success_u32(data0: u32) -> Self

Successful command with an additional 32-bit data field

pub fn success_u32_u32(data0: u32, data1: u32) -> Self

Successful command with two additional 32-bit data fields

pub fn success_u32_u32_u32(data0: u32, data1: u32, data2: u32) -> Self

Successful command with three additional 32-bit data fields

pub fn success_u64(data0: u64) -> Self

Successful command with an additional 64-bit data field

pub fn success_u32_u64(data0: u32, data1: u64) -> Self

Successful command with an additional 64-bit and 32-bit data field

Trait Implementations

impl From<Error> for CommandReturn

fn from(perr: Error) -> Self

Converts to this type from the input type.

impl From<Result<(), ErrorCode>> for CommandReturn

fn from(rc: Result<(), ErrorCode>) -> Self

Converts to this type from the input type.