Struct ResultCode

#[repr(C)]
pub struct ResultCode { /* private fields */ }

Represents a (raw) result value used all over the OS

These are referred as Result on docs/official code, but we intentionally name it as ResultCode to distinguish it from the Result enum type

Results are often displayed/shown, for example, like 2168-0002, which corresponds to <2000 + module>-<description>

[Debug][fmt::Debug] formatting formats the results as a hex-value (0x4A8), while [Display][fmt::Display] formatting formats the result in the format described above (2168-0002)

Implementations

impl ResultCode

pub const fn new(value: u32) -> Self

Creates a ResultCode from a raw value

Arguments

• value: The raw value

pub const fn new_err<T>(value: u32) -> Result<T>

Wrapper for creating a new [Result::Err] value with the following raw result

Arguments

• value: The raw value, note that it mustn’t be 0/success (that would be undefined behavior)

pub const fn is_success(&self) -> bool

Returns whether the ResultCode is successful

A result value of 0 is a successful value, this essentially checks that

pub const fn is_failure(&self) -> bool

Returns whether the ResultCode is not successful

This is the exact opposite of is_success

pub const fn get_value(&self) -> u32

Gets the raw value of the ResultCode

pub const fn get_module(&self) -> u32

Gets the module of the ResultCode

pub const fn get_description(&self) -> u32

Gets the description of the ResultCode

Trait Implementations

impl Clone for ResultCode

fn clone(&self) -> ResultCode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResultCode

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

Formats the value using the given formatter.

impl Default for ResultCode

fn default() -> ResultCode

Returns the “default value” for a type.

impl Display for ResultCode

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

Formats the value using the given formatter.

impl From<AllocError> for ResultCode

fn from(_value: AllocError) -> Self

Converts to this type from the input type.

impl PartialEq for ResultCode

fn eq(&self, other: &ResultCode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestCommandParameter<ResultCode> for ResultCode

fn after_request_read(ctx: &mut ServerContext<'_>) -> Result<Self>

impl RequestCommandParameter for ResultCode

fn before_request_write( _raw: &Self, walker: &mut DataWalker, ctx: &mut CommandContext, ) -> Result<()>

fn before_send_sync_request( raw: &Self, walker: &mut DataWalker, ctx: &mut CommandContext, ) -> Result<()>

impl ResponseCommandParameter<ResultCode> for ResultCode

fn after_response_read( walker: &mut DataWalker, ctx: &mut CommandContext, ) -> Result<Self>

impl ResponseCommandParameter for ResultCode

type CarryState = ()

fn before_response_write( _raw: &Self, ctx: &mut ServerContext<'_>, ) -> Result<Self::CarryState>

fn after_response_write( raw: Self, _carry_state: Self::CarryState, ctx: &mut ServerContext<'_>, ) -> Result<()>

impl Copy for ResultCode

impl Eq for ResultCode

impl StructuralPartialEq for ResultCode