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§
Source§impl UStatus
impl UStatus
Sourcepub fn ok() -> Self
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);
Sourcepub fn fail<M: Into<String>>(msg: M) -> Self
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");
Sourcepub fn fail_with_code<M: Into<String>>(code: UCode, msg: M) -> Self
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");
Sourcepub fn is_failed(&self) -> bool
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());
Sourcepub fn is_success(&self) -> bool
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());
Sourcepub fn get_message(&self) -> String
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());
Sourcepub fn get_code(&self) -> UCode
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);
Trait Implementations§
Source§impl Error for UStatus
impl Error for UStatus
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
Source§impl From<ServiceInvocationError> for UStatus
impl From<ServiceInvocationError> for UStatus
Source§fn from(value: ServiceInvocationError) -> Self
fn from(value: ServiceInvocationError) -> Self
Converts to this type from the input type.
Source§impl From<UStatus> for RegistrationError
impl From<UStatus> for RegistrationError
Source§impl From<UStatus> for ServiceInvocationError
impl From<UStatus> for ServiceInvocationError
Source§impl Message for UStatus
impl Message for UStatus
Source§fn is_initialized(&self) -> bool
fn is_initialized(&self) -> bool
True iff all required fields are initialized.
Always returns
true
for protobuf 3.Source§fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>
fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>
Update this message object with fields read from given stream.
Source§fn compute_size(&self) -> u64
fn compute_size(&self) -> u64
Compute and cache size of this message and all nested messages. Read more
Source§fn write_to_with_cached_sizes(
&self,
os: &mut CodedOutputStream<'_>,
) -> Result<()>
fn write_to_with_cached_sizes( &self, os: &mut CodedOutputStream<'_>, ) -> Result<()>
Write message to the stream. Read more
Source§fn special_fields(&self) -> &SpecialFields
fn special_fields(&self) -> &SpecialFields
Special fields (unknown fields and cached size).
Source§fn mut_special_fields(&mut self) -> &mut SpecialFields
fn mut_special_fields(&mut self) -> &mut SpecialFields
Special fields (unknown fields and cached size).
Source§fn default_instance() -> &'static UStatus
fn default_instance() -> &'static UStatus
Return a pointer to default immutable message with static lifetime. Read more
Source§fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self, Error>
fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self, Error>
Parse message from stream.
Source§fn cached_size(&self) -> u32
fn cached_size(&self) -> u32
Get size previously computed by
compute_size
. Read moreSource§fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<(), Error>
fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<(), Error>
Write the message to the stream. Read more
Source§fn write_length_delimited_to(
&self,
os: &mut CodedOutputStream<'_>,
) -> Result<(), Error>
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.
Source§fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<(), Error>
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.
Source§fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<(), Error>
fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<(), Error>
Update this message object with fields read from given stream.
Source§fn parse_from_reader(reader: &mut dyn Read) -> Result<Self, Error>
fn parse_from_reader(reader: &mut dyn Read) -> Result<Self, Error>
Parse message from reader.
Parse stops on EOF or when error encountered.
Source§fn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self, Error>
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.Source§fn check_initialized(&self) -> Result<(), Error>
fn check_initialized(&self) -> Result<(), Error>
Check if all required fields of this object are initialized.
Source§fn write_to_writer(&self, w: &mut dyn Write) -> Result<(), Error>
fn write_to_writer(&self, w: &mut dyn Write) -> Result<(), Error>
Write the message to the writer.
Source§fn write_length_delimited_to_writer(
&self,
w: &mut dyn Write,
) -> Result<(), Error>
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.
Source§fn write_length_delimited_to_bytes(&self) -> Result<Vec<u8>, Error>
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.
Source§fn unknown_fields(&self) -> &UnknownFields
fn unknown_fields(&self) -> &UnknownFields
Get a reference to unknown fields.
Source§fn mut_unknown_fields(&mut self) -> &mut UnknownFields
fn mut_unknown_fields(&mut self) -> &mut UnknownFields
Get a mutable reference to unknown fields.
Source§impl MessageFull for UStatus
impl MessageFull for UStatus
Source§fn descriptor() -> MessageDescriptor
fn descriptor() -> MessageDescriptor
Get message descriptor for message type. Read more
Source§fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool
fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool
Reflective equality. Read more
Source§impl ProtobufValue for UStatus
impl ProtobufValue for UStatus
Source§type RuntimeType = RuntimeTypeMessage<UStatus>
type RuntimeType = RuntimeTypeMessage<UStatus>
Actual implementation of type properties.
impl StructuralPartialEq for UStatus
Auto Trait Implementations§
impl !Freeze for UStatus
impl RefUnwindSafe for UStatus
impl Send for UStatus
impl Sync for UStatus
impl Unpin for UStatus
impl UnwindSafe for UStatus
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<M> MessageDyn for Mwhere
M: MessageFull,
impl<M> MessageDyn for Mwhere
M: MessageFull,
Source§fn descriptor_dyn(&self) -> MessageDescriptor
fn descriptor_dyn(&self) -> MessageDescriptor
Message descriptor for this message, used for reflection.
Source§fn merge_from_dyn(&mut self, is: &mut CodedInputStream<'_>) -> Result<(), Error>
fn merge_from_dyn(&mut self, is: &mut CodedInputStream<'_>) -> Result<(), Error>
Update this message fields with contents of given stream.
Source§fn write_to_with_cached_sizes_dyn(
&self,
os: &mut CodedOutputStream<'_>,
) -> Result<(), Error>
fn write_to_with_cached_sizes_dyn( &self, os: &mut CodedOutputStream<'_>, ) -> Result<(), Error>
Write the message.
Source§fn compute_size_dyn(&self) -> u64
fn compute_size_dyn(&self) -> u64
Compute (and cache) the message size.
Source§fn is_initialized_dyn(&self) -> bool
fn is_initialized_dyn(&self) -> bool
True iff all required fields are initialized.
Always returns
true
for protobuf 3.Source§fn special_fields_dyn(&self) -> &SpecialFields
fn special_fields_dyn(&self) -> &SpecialFields
Get a reference to special fields.
Source§fn mut_special_fields_dyn(&mut self) -> &mut SpecialFields
fn mut_special_fields_dyn(&mut self) -> &mut SpecialFields
Get a mutable reference to special fields.