Struct UStatus

Source

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

Expand description

Operation status: a UCode with optional message and details.

Implementations§

Source §

impl UStatus

Source

pub fn ok() -> Self

Creates a status representing a success.

§Examples

use up_rust::{UCode, UStatus};

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

Source

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::DataLoss, "something went wrong");
assert_eq!(status.code(), UCode::DataLoss);
assert_eq!(status.message().unwrap(), "something went wrong");

Source

pub fn new<M: Into<String>>( code: UCode, msg: Option<M>, details: Option<Vec<UAny>>, ) -> Self

Creates a status from a code and an optional message.

§Examples

use up_rust::{UCode, UStatus};

let status = UStatus::new(UCode::DataLoss, Some("something went wrong"), None);
assert_eq!(status.code(), UCode::DataLoss);
assert_eq!(status.message().unwrap(), "something went wrong");
assert!(status.details().is_empty());

Source

pub fn is_failed(&self) -> bool

Checks if this status represents a failure.

§Examples

use up_rust::{UCode, UStatus};

let failed_status = UStatus::fail_with_code(UCode::Internal, "something went wrong");
assert!(failed_status.is_failed());

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

Source

pub fn is_success(&self) -> bool

Checks if this status represents a success.

§Examples

use up_rust::{UCode, UStatus};

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

let failed_status = UStatus::fail_with_code(UCode::Internal, "something went wrong");
assert!(!failed_status.is_success());

Source

pub fn message(&self) -> Option<&str>

Gets this status’ error message.

§Returns

an empty string if this instance has been created without a message.

§Examples

use up_rust::{UCode, UStatus};

let failed_status = UStatus::fail_with_code(UCode::Internal, "my error message");
assert_eq!(failed_status.message(), Some("my error message"));

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

Source

pub fn get_message(&self) -> Option<&str>

👎Deprecated since 0.11.0: renamed to message

Deprecated alias for Self::message.

Source

pub fn message_or_default<'a>(&'a self, default: &'a str) -> &'a str

Gets this status’ error message or a default value if none is set.

§Arguments

default - The default value to return if this status has no message.

§Returns

the error message if set, otherwise the provided default value.

§Examples

use up_rust::{UCode, UStatus};

let failed_status = UStatus::fail_with_code(UCode::Internal, "my error message");
assert_eq!(failed_status.message_or_default("default"), "my error message");

let succeeded_status = UStatus::ok();
assert_eq!(succeeded_status.message_or_default("default"), "default");

Source

pub fn get_message_or_default<'a>(&'a self, default: &'a str) -> &'a str

👎Deprecated since 0.11.0: renamed to message_or_default

Deprecated alias for Self::message_or_default.

Source

pub fn code(&self) -> UCode

Gets this status’ error code.

§Examples

use up_rust::{UCode, UStatus};

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

Source

pub fn get_code(&self) -> UCode

👎Deprecated since 0.11.0: renamed to code

Deprecated alias for Self::code.

Source

pub fn details(&self) -> &[UAny]

Gets this status’ details.

§Examples

use up_rust::{UAny, UCode, UStatus};

let details = vec![UAny::new("type.googleapis.com/google.protobuf.StringValue".to_string(), b"the string".as_ref())];
let status_with_details = UStatus::new(UCode::Internal, Some("my error message"), Some(details.clone()));
assert_eq!(status_with_details.details(), details.as_slice());

let status_without_details = UStatus::fail_with_code(UCode::Internal, "my error message");
assert!(status_without_details.details().is_empty());