Struct kernel::syscall_driver::CommandReturn

source ·
pub struct CommandReturn(SyscallReturn);
Expand description

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.

Tuple Fields§

§0: SyscallReturn

Implementations§

source§

impl CommandReturn

source

pub(crate) fn into_inner(self) -> SyscallReturn

source

pub fn failure(rc: ErrorCode) -> Self

Command error

source

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

Command error with an additional 32-bit data field

source

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

Command error with two additional 32-bit data fields

source

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

Command error with an additional 64-bit data field

source

pub fn success() -> Self

Successful command

source

pub fn success_u32(data0: u32) -> Self

Successful command with an additional 32-bit data field

source

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

Successful command with two additional 32-bit data fields

source

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

Successful command with three additional 32-bit data fields

source

pub fn success_u64(data0: u64) -> Self

Successful command with an additional 64-bit data field

source

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

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

Trait Implementations§

source§

impl From<Error> for CommandReturn

source§

fn from(perr: Error) -> Self

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.

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> 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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.