Struct ThinStatus 

pub struct ThinStatus { /* private fields */ }

Holds a non-OK status code (in most cases ErrorCode), a descriptive string message, and optionally (if enabled by feature use_any) also [google_cloud_wkt::Any].

It occupies only a single pointer word, which either wraps a tagged integer code (if there is neither message nor details), or a ThinArc pointer that holds a more complex value. Furthermore its representation is never nullptr, therefore Option<ThinStatus> and Result<(), ThinStatus> occupy just a single memory word.

Note that Copy, Eq, PartialOrd and Hash are only provided (derived) when feature use_any is disabled, since the Any datatype doesn’t provide them.

Implementations

impl ThinStatus

pub fn builder<'a, C: Into<NonZeroI32>>(code: C) -> ThinStatusBuilder<'a>

Constructs a builder that allows convenient creation of ThinStatus instances.

pub fn from_code<C: Into<NonZeroI32>>(code: C) -> Self

A utility function to create a status with just a raw code. If it fits, it’ll be stored just as a tagged integer inside an internal pointer.

pub fn code(&self) -> Option<ErrorCode>

Returns the stored error code, or None if the raw numerical value doesn’t match any of the ErrorCode values.

pub fn code_or_unknown(&self) -> ErrorCode

Convenience wrapper to code() that converts an unknown error to ErrorCode::Unknown.

pub fn code_raw(&self) -> NonZeroI32

Returns the raw numerical error code.

pub fn message(&self) -> &str

Returns the message attached to the status (if any).

Trait Implementations

impl Clone for ThinStatus

fn clone(&self) -> ThinStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThinStatus

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

Formats the value using the given formatter.

impl Display for ThinStatus

If the contained error code corresponds to an ErrorCode (code() returns Some(...)), it’s printed as an upper-case string (such as NOT_FOUND); otherwise just as a number. This is followed by a colon, space and the contained message (if there is any).

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

If the alternate flag is set, always prints the error code as a number.

impl Eq for ThinStatus

impl Error for ThinStatus

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<&Error> for ThinStatus

fn from(err: &Error) -> Self

Converts to this type from the input type.

impl From<Error> for ThinStatus

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<ErrorCode> for ThinStatus

fn from(code: ErrorCode) -> Self

Converts to this type from the input type.

impl From<ThinStatusBuilder<'_>> for ThinStatus

fn from(builder: ThinStatusBuilder<'_>) -> Self

Converts to this type from the input type.

impl Hash for ThinStatus

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ThinStatus

fn cmp(&self, other: &ThinStatus) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ThinStatus

fn eq(&self, other: &ThinStatus) -> 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 PartialOrd for ThinStatus

fn partial_cmp(&self, other: &ThinStatus) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ThinStatus