Struct Failure 

pub struct Failure {
    pub message: String,
    pub source: String,
    pub stack_trace: String,
    pub encoded_attributes: Option<Payload>,
    pub cause: Option<Box<Failure>>,
    pub failure_info: Option<FailureInfo>,
}

Fields

message: String

source: String

The source this Failure originated in, e.g. TypeScriptSDK / JavaSDK In some SDKs this is used to rehydrate the stack trace into an exception object.

stack_trace: String

encoded_attributes: Option<Payload>

Alternative way to supply message and stack_trace and possibly other attributes, used for encryption of errors originating in user code which might contain sensitive information. The encoded_attributes Payload could represent any serializable object, e.g. JSON object or a Failure proto message.

SDK authors:

• The SDK should provide a default encodeFailureAttributes and decodeFailureAttributes implementation that:

  • Uses a JSON object to represent { message, stack_trace }.
  • Overwrites the original message with “Encoded failure” to indicate that more information could be extracted.
  • Overwrites the original stack_trace with an empty string.
  • The resulting JSON object is converted to Payload using the default PayloadConverter and should be processed by the user-provided PayloadCodec

• If there’s demand, we could allow overriding the default SDK implementation to encode other opaque Failure attributes. (– api-linter: core::0203::optional=disabled –)

cause: Option<Box<Failure>>

failure_info: Option<FailureInfo>

Implementations

impl Failure

pub fn is_timeout(&self) -> Option<TimeoutType>

pub fn application_failure(message: String, non_retryable: bool) -> Self

pub fn application_failure_from_error(ae: Error, non_retryable: bool) -> Self

pub fn timeout(timeout_type: TimeoutType) -> Self

pub fn maybe_application_failure(&self) -> Option<&ApplicationFailureInfo>

Extracts an ApplicationFailureInfo from a Failure instance if it exists

pub fn is_benign_application_failure(&self) -> bool

Trait Implementations

impl Clone for Failure

fn clone(&self) -> Failure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Failure

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

Formats the value using the given formatter.

impl Default for Failure

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Failure

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Failure

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

Formats the value using the given formatter.

impl From<&str> for Failure

fn from(v: &str) -> Self

Converts to this type from the input type.

impl From<Error> for Failure

fn from(ae: Error) -> Self

Converts to this type from the input type.

impl From<Failure> for Failure

fn from(f: Failure) -> Self

Converts to this type from the input type.

impl From<Failure> for Variant

fn from(value: Failure) -> Self

Converts to this type from the input type.

impl From<String> for Failure

fn from(v: String) -> Self

Converts to this type from the input type.

impl Message for Failure

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for Failure

const NAME: &'static str = "Failure"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "temporal.api.failure.v1"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for Failure

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

fn visit_payloads_mut<'a>( &'a mut self, visitor: &'a mut (dyn AsyncPayloadVisitor + Send), ) -> BoxFuture<'a, ()>

Visit all payload fields in this message. The visitor is called once per field, receiving the field’s payload(s).

impl Serialize for Failure

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Failure> for Failure

type Error = Error

The type returned in the event of a conversion error.

fn try_from(f: Failure) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Failure