Enum Error

pub enum Error {
    Transport(TransportError),
    Protocol(ProtocolError),
    Application(ApplicationError),
}

Error type returned by all runtime library functions.

thrift::Error is used throughout this crate as well as in auto-generated Rust code. It consists of four variants defined by convention across Thrift implementations:

1. Transport: errors encountered while operating on I/O channels
2. Protocol: errors encountered during runtime-library processing
3. Application: errors encountered within auto-generated code
4. User: IDL-defined exception structs

The Application variant also functions as a catch-all: all handler errors are automatically turned into application errors.

All error variants except Error::User take an eponymous struct with two required fields:

1. kind: variant-specific enum identifying the error sub-type
2. message: human-readable error info string

kind is defined by convention while message is freeform. If none of the enumerated kinds are suitable use Unknown.

To simplify error creation convenience constructors are defined for all variants, and conversions from their structs (thrift::TransportError, thrift::ProtocolError and thrift::ApplicationError into thrift::Error.

Variants

Transport(TransportError)

Errors encountered while operating on I/O channels.

These include connection closed and bind failure.

Protocol(ProtocolError)

Errors encountered during runtime-library processing.

These include message too large and unsupported protocol version.

Application(ApplicationError)

Errors encountered within auto-generated code, or when incoming or outgoing messages violate the Thrift spec.

These include out-of-order messages and missing required struct fields.

This variant also functions as a catch-all: errors from handler functions are automatically returned as an ApplicationError.

Implementations

impl Error

pub fn read_application_error_from_in_protocol<T: TInputProtocol>( i: &mut T, ) -> Result<ApplicationError>

Create an ApplicationError from its wire representation.

Application code should never call this method directly.

pub fn write_application_error_to_out_protocol( e: &ApplicationError, o: &mut dyn TOutputProtocol, ) -> Result<()>

Convert an ApplicationError into its wire representation and write it to the remote.

Application code should never call this method directly.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<'a> From<&'a str> for Error

fn from(s: &'a str) -> Self

Converts to this type from the input type.

impl From<ApplicationError> for Error

fn from(e: ApplicationError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(err: FromUtf8Error) -> Self

Converts to this type from the input type.

impl From<Infallible> for Error

fn from(err: Infallible) -> Self

Converts to this type from the input type.

impl From<ProtocolError> for Error

fn from(e: ProtocolError) -> Self

Converts to this type from the input type.

impl From<String> for Error

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<TransportError> for Error

fn from(e: TransportError) -> Self

Converts to this type from the input type.

impl From<TryFromIntError> for Error

fn from(err: TryFromIntError) -> Self

Converts to this type from the input type.

impl From<TryReserveError> for Error

fn from(err: TryReserveError) -> Self

Converts to this type from the input type.