Struct UStatus

pub struct UStatus {
    pub code: EnumOrUnknown<UCode>,
    pub message: Option<String>,
    pub details: Vec<Any>,
    pub special_fields: SpecialFields,
}

Fields

code: EnumOrUnknown<UCode>

message: Option<String>

details: Vec<Any>

special_fields: SpecialFields

Implementations

impl UStatus

pub fn ok() -> Self

Creates a status representing a success.

Examples

use up_rust::{UCode, UStatus};

let status = UStatus::ok();
assert_eq!(status.code.unwrap(), UCode::OK);

pub fn fail<M: Into<String>>(msg: M) -> Self

Creates a status representing a failure.

Examples

use up_rust::UStatus;

let status = UStatus::fail("something went wrong");
assert_eq!(status.message.unwrap(), "something went wrong");

pub fn fail_with_code<M: Into<String>>(code: UCode, msg: M) -> Self

Creates a status representing a failure.

Examples

use up_rust::{UCode, UStatus};

let status = UStatus::fail_with_code(UCode::DATA_LOSS, "something went wrong");
assert_eq!(status.code.unwrap(), UCode::DATA_LOSS);
assert_eq!(status.message.unwrap(), "something went wrong");

pub fn is_failed(&self) -> bool

Checks if this status represents a failure.

Examples

use up_rust::UStatus;

let failed_status = UStatus::fail("something went wrong");
assert!(failed_status.is_failed());

let succeeded_status = UStatus::ok();
assert!(!succeeded_status.is_failed());

pub fn is_success(&self) -> bool

Checks if this status represents a success.

Examples

use up_rust::UStatus;

let succeeded_status = UStatus::ok();
assert!(succeeded_status.is_success());

let failed_status = UStatus::fail("something went wrong");
assert!(!failed_status.is_success());

pub fn get_message(&self) -> String

Gets this status’ error message.

Returns

an empty string if this instance has been created without a message, i.e. not using one of its factory functions.

Examples

use up_rust::UStatus;

let failed_status = UStatus::fail("my error message");
assert_eq!(failed_status.get_message(), "my error message");

let succeeded_status = UStatus::ok();
assert!(succeeded_status.get_message().is_empty());

pub fn get_code(&self) -> UCode

Gets this status’ error code.

Returns

UCode::UNKNOWN if this status has been created without providing an error code.

Examples

use up_rust::{UCode, UStatus};

let status = UStatus::fail("my error message");
assert_eq!(status.get_code(), UCode::UNKNOWN);

let status_with_code = UStatus::fail_with_code(UCode::INTERNAL, "my error message");
assert_eq!(status_with_code.get_code(), UCode::INTERNAL);

impl UStatus

pub fn new() -> UStatus

Trait Implementations

impl Clone for UStatus

fn clone(&self) -> UStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UStatus

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

Formats the value using the given formatter.

impl<'a> Default for &'a UStatus

fn default() -> &'a UStatus

Returns the “default value” for a type.

impl Default for UStatus

fn default() -> UStatus

Returns the “default value” for a type.

impl Display for UStatus

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

Formats the value using the given formatter.

impl Error for UStatus

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<ServiceInvocationError> for UStatus

fn from(value: ServiceInvocationError) -> Self

Converts to this type from the input type.

impl From<UStatus> for RegistrationError

fn from(value: UStatus) -> Self

Converts to this type from the input type.

impl From<UStatus> for ServiceInvocationError

fn from(value: UStatus) -> Self

Converts to this type from the input type.

impl Message for UStatus

const NAME: &'static str = "UStatus"

Message name as specified in .proto file.

fn is_initialized(&self) -> bool

True iff all required fields are initialized. Always returns true for protobuf 3.

fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>

Update this message object with fields read from given stream.

fn compute_size(&self) -> u64

Compute and cache size of this message and all nested messages.

fn write_to_with_cached_sizes( &self, os: &mut CodedOutputStream<'_>, ) -> Result<()>

Write message to the stream.

fn special_fields(&self) -> &SpecialFields

Special fields (unknown fields and cached size).

fn mut_special_fields(&mut self) -> &mut SpecialFields

Special fields (unknown fields and cached size).

fn new() -> UStatus

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static UStatus

Return a pointer to default immutable message with static lifetime.

fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self, Error>

Parse message from stream.

fn cached_size(&self) -> u32

Get size previously computed by compute_size.

fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<(), Error>

Write the message to the stream.

fn write_length_delimited_to( &self, os: &mut CodedOutputStream<'_>, ) -> Result<(), Error>

Write the message to the stream prepending the message with message length encoded as varint.

fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<(), Error>

Write the message to the vec, prepend the message with message length encoded as varint.

fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<(), Error>

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> Result<Self, Error>

Parse message from reader. Parse stops on EOF or when error encountered.

fn parse_from_bytes(bytes: &[u8]) -> Result<Self, Error>

Parse message from byte array.

fn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self, Error>

Parse message from Bytes object. Resulting message may share references to the passed bytes object.

fn check_initialized(&self) -> Result<(), Error>

Check if all required fields of this object are initialized.

fn write_to_writer(&self, w: &mut dyn Write) -> Result<(), Error>

Write the message to the writer.

fn write_to_vec(&self, v: &mut Vec<u8>) -> Result<(), Error>

Write the message to bytes vec.

fn write_to_bytes(&self) -> Result<Vec<u8>, Error>

Write the message to bytes vec.

fn write_length_delimited_to_writer( &self, w: &mut dyn Write, ) -> Result<(), Error>

Write the message to the writer, prepend the message with message length encoded as varint.

fn write_length_delimited_to_bytes(&self) -> Result<Vec<u8>, Error>

Write the message to the bytes vec, prepend the message with message length encoded as varint.

fn unknown_fields(&self) -> &UnknownFields

Get a reference to unknown fields.

fn mut_unknown_fields(&mut self) -> &mut UnknownFields

Get a mutable reference to unknown fields.

impl MessageFull for UStatus

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool

Reflective equality.

impl PartialEq for UStatus

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

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

const 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 ProtobufValue for UStatus

type RuntimeType = RuntimeTypeMessage<UStatus>

Actual implementation of type properties.

impl StructuralPartialEq for UStatus