thrift/errors.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
use std::convert::TryFrom;
use std::convert::{From, Into};
use std::fmt::{Debug, Display, Formatter};
use std::{error, fmt, io, string};
use crate::protocol::{
TFieldIdentifier, TInputProtocol, TOutputProtocol, TStructIdentifier, TType,
};
// FIXME: should all my error structs impl error::Error as well?
// FIXME: should all fields in TransportError, ProtocolError and ApplicationError be optional?
/// 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`.
///
/// # Examples
///
/// Create a `TransportError`.
///
/// ```
/// use thrift::{TransportError, TransportErrorKind};
///
/// // explicit
/// let err0: thrift::Result<()> = Err(
/// thrift::Error::Transport(
/// TransportError {
/// kind: TransportErrorKind::TimedOut,
/// message: format!("connection to server timed out")
/// }
/// )
/// );
///
/// // use conversion
/// let err1: thrift::Result<()> = Err(
/// thrift::Error::from(
/// TransportError {
/// kind: TransportErrorKind::TimedOut,
/// message: format!("connection to server timed out")
/// }
/// )
/// );
///
/// // use struct constructor
/// let err2: thrift::Result<()> = Err(
/// thrift::Error::Transport(
/// TransportError::new(
/// TransportErrorKind::TimedOut,
/// "connection to server timed out"
/// )
/// )
/// );
///
///
/// // use error variant constructor
/// let err3: thrift::Result<()> = Err(
/// thrift::new_transport_error(
/// TransportErrorKind::TimedOut,
/// "connection to server timed out"
/// )
/// );
/// ```
///
/// Create an error from a string.
///
/// ```
/// use thrift::{ApplicationError, ApplicationErrorKind};
///
/// // we just use `From::from` to convert a `String` into a `thrift::Error`
/// let err0: thrift::Result<()> = Err(
/// thrift::Error::from("This is an error")
/// );
///
/// // err0 is equivalent to...
/// let err1: thrift::Result<()> = Err(
/// thrift::Error::Application(
/// ApplicationError {
/// kind: ApplicationErrorKind::Unknown,
/// message: format!("This is an error")
/// }
/// )
/// );
/// ```
///
/// Return an IDL-defined exception.
///
/// ```text
/// // Thrift IDL exception definition.
/// exception Xception {
/// 1: i32 errorCode,
/// 2: string message
/// }
/// ```
///
/// ```
/// use std::error::Error;
/// use std::fmt;
/// use std::fmt::{Display, Formatter};
///
/// // auto-generated by the Thrift compiler
/// #[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
/// pub struct Xception {
/// pub error_code: Option<i32>,
/// pub message: Option<String>,
/// }
///
/// // auto-generated by the Thrift compiler
/// impl Error for Xception { }
///
/// // auto-generated by the Thrift compiler
/// impl From<Xception> for thrift::Error {
/// fn from(e: Xception) -> Self {
/// thrift::Error::User(Box::new(e))
/// }
/// }
///
/// // auto-generated by the Thrift compiler
/// impl Display for Xception {
/// fn fmt(&self, f: &mut Formatter) -> fmt::Result {
/// write!(f, "remote service threw Xception")
/// }
/// }
///
/// // in user code...
/// let err: thrift::Result<()> = Err(
/// thrift::Error::from(Xception { error_code: Some(1), message: None })
/// );
/// ```
pub enum Error {
/// Errors encountered while operating on I/O channels.
///
/// These include *connection closed* and *bind failure*.
Transport(TransportError),
/// Errors encountered during runtime-library processing.
///
/// These include *message too large* and *unsupported protocol version*.
Protocol(ProtocolError),
/// 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`.
Application(ApplicationError),
/// IDL-defined exception structs.
User(Box<dyn error::Error + Sync + Send>),
}
impl Error {
/// Create an `ApplicationError` from its wire representation.
///
/// Application code **should never** call this method directly.
pub fn read_application_error_from_in_protocol(
i: &mut dyn TInputProtocol,
) -> crate::Result<ApplicationError> {
let mut message = "general remote error".to_owned();
let mut kind = ApplicationErrorKind::Unknown;
i.read_struct_begin()?;
loop {
let field_ident = i.read_field_begin()?;
if field_ident.field_type == TType::Stop {
break;
}
let id = field_ident
.id
.expect("sender should always specify id for non-STOP field");
match id {
1 => {
let remote_message = i.read_string()?;
i.read_field_end()?;
message = remote_message;
}
2 => {
let remote_type_as_int = i.read_i32()?;
let remote_kind: ApplicationErrorKind = TryFrom::try_from(remote_type_as_int)
.unwrap_or(ApplicationErrorKind::Unknown);
i.read_field_end()?;
kind = remote_kind;
}
_ => {
i.skip(field_ident.field_type)?;
}
}
}
i.read_struct_end()?;
Ok(ApplicationError { kind, message })
}
/// Convert an `ApplicationError` into its wire representation and write
/// it to the remote.
///
/// Application code **should never** call this method directly.
pub fn write_application_error_to_out_protocol(
e: &ApplicationError,
o: &mut dyn TOutputProtocol,
) -> crate::Result<()> {
o.write_struct_begin(&TStructIdentifier {
name: "TApplicationException".to_owned(),
})?;
let message_field = TFieldIdentifier::new("message", TType::String, 1);
let type_field = TFieldIdentifier::new("type", TType::I32, 2);
o.write_field_begin(&message_field)?;
o.write_string(&e.message)?;
o.write_field_end()?;
o.write_field_begin(&type_field)?;
o.write_i32(e.kind as i32)?;
o.write_field_end()?;
o.write_field_stop()?;
o.write_struct_end()?;
o.flush()
}
}
impl error::Error for Error {}
impl Debug for Error {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
match *self {
Error::Transport(ref e) => Debug::fmt(e, f),
Error::Protocol(ref e) => Debug::fmt(e, f),
Error::Application(ref e) => Debug::fmt(e, f),
Error::User(ref e) => Debug::fmt(e, f),
}
}
}
impl Display for Error {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
match *self {
Error::Transport(ref e) => Display::fmt(e, f),
Error::Protocol(ref e) => Display::fmt(e, f),
Error::Application(ref e) => Display::fmt(e, f),
Error::User(ref e) => Display::fmt(e, f),
}
}
}
impl From<String> for Error {
fn from(s: String) -> Self {
Error::Application(ApplicationError {
kind: ApplicationErrorKind::Unknown,
message: s,
})
}
}
impl<'a> From<&'a str> for Error {
fn from(s: &'a str) -> Self {
Error::Application(ApplicationError {
kind: ApplicationErrorKind::Unknown,
message: String::from(s),
})
}
}
impl From<TransportError> for Error {
fn from(e: TransportError) -> Self {
Error::Transport(e)
}
}
impl From<ProtocolError> for Error {
fn from(e: ProtocolError) -> Self {
Error::Protocol(e)
}
}
impl From<ApplicationError> for Error {
fn from(e: ApplicationError) -> Self {
Error::Application(e)
}
}
/// Create a new `Error` instance of type `Transport` that wraps a
/// `TransportError`.
pub fn new_transport_error<S: Into<String>>(kind: TransportErrorKind, message: S) -> Error {
Error::Transport(TransportError::new(kind, message))
}
/// Information about I/O errors.
#[derive(Debug, Eq, PartialEq)]
pub struct TransportError {
/// I/O error variant.
///
/// If a specific `TransportErrorKind` does not apply use
/// `TransportErrorKind::Unknown`.
pub kind: TransportErrorKind,
/// Human-readable error message.
pub message: String,
}
impl TransportError {
/// Create a new `TransportError`.
pub fn new<S: Into<String>>(kind: TransportErrorKind, message: S) -> TransportError {
TransportError {
kind,
message: message.into(),
}
}
}
/// I/O error categories.
///
/// This list may grow, and it is not recommended to match against it.
#[non_exhaustive]
#[derive(Clone, Copy, Eq, Debug, PartialEq)]
pub enum TransportErrorKind {
/// Catch-all I/O error.
Unknown = 0,
/// An I/O operation was attempted when the transport channel was not open.
NotOpen = 1,
/// The transport channel cannot be opened because it was opened previously.
AlreadyOpen = 2,
/// An I/O operation timed out.
TimedOut = 3,
/// A read could not complete because no bytes were available.
EndOfFile = 4,
/// An invalid (buffer/message) size was requested or received.
NegativeSize = 5,
/// Too large a buffer or message size was requested or received.
SizeLimit = 6,
}
impl Display for TransportError {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
let error_text = match self.kind {
TransportErrorKind::Unknown => "transport error",
TransportErrorKind::NotOpen => "not open",
TransportErrorKind::AlreadyOpen => "already open",
TransportErrorKind::TimedOut => "timed out",
TransportErrorKind::EndOfFile => "end of file",
TransportErrorKind::NegativeSize => "negative size message",
TransportErrorKind::SizeLimit => "message too long",
};
write!(f, "{}", error_text)
}
}
impl TryFrom<i32> for TransportErrorKind {
type Error = Error;
fn try_from(from: i32) -> Result<Self, Self::Error> {
match from {
0 => Ok(TransportErrorKind::Unknown),
1 => Ok(TransportErrorKind::NotOpen),
2 => Ok(TransportErrorKind::AlreadyOpen),
3 => Ok(TransportErrorKind::TimedOut),
4 => Ok(TransportErrorKind::EndOfFile),
5 => Ok(TransportErrorKind::NegativeSize),
6 => Ok(TransportErrorKind::SizeLimit),
_ => Err(Error::Protocol(ProtocolError {
kind: ProtocolErrorKind::Unknown,
message: format!("cannot convert {} to TransportErrorKind", from),
})),
}
}
}
impl From<io::Error> for Error {
fn from(err: io::Error) -> Self {
match err.kind() {
io::ErrorKind::ConnectionReset
| io::ErrorKind::ConnectionRefused
| io::ErrorKind::NotConnected => Error::Transport(TransportError {
kind: TransportErrorKind::NotOpen,
message: err.to_string(),
}),
io::ErrorKind::AlreadyExists => Error::Transport(TransportError {
kind: TransportErrorKind::AlreadyOpen,
message: err.to_string(),
}),
io::ErrorKind::TimedOut => Error::Transport(TransportError {
kind: TransportErrorKind::TimedOut,
message: err.to_string(),
}),
io::ErrorKind::UnexpectedEof => Error::Transport(TransportError {
kind: TransportErrorKind::EndOfFile,
message: err.to_string(),
}),
_ => {
Error::Transport(TransportError {
kind: TransportErrorKind::Unknown,
message: err.to_string(), // FIXME: use io error's debug string
})
}
}
}
}
impl From<string::FromUtf8Error> for Error {
fn from(err: string::FromUtf8Error) -> Self {
Error::Protocol(ProtocolError {
kind: ProtocolErrorKind::InvalidData,
message: err.to_string(), // FIXME: use fmt::Error's debug string
})
}
}
/// Create a new `Error` instance of type `Protocol` that wraps a
/// `ProtocolError`.
pub fn new_protocol_error<S: Into<String>>(kind: ProtocolErrorKind, message: S) -> Error {
Error::Protocol(ProtocolError::new(kind, message))
}
/// Information about errors that occur in the runtime library.
#[derive(Debug, Eq, PartialEq)]
pub struct ProtocolError {
/// Protocol error variant.
///
/// If a specific `ProtocolErrorKind` does not apply use
/// `ProtocolErrorKind::Unknown`.
pub kind: ProtocolErrorKind,
/// Human-readable error message.
pub message: String,
}
impl ProtocolError {
/// Create a new `ProtocolError`.
pub fn new<S: Into<String>>(kind: ProtocolErrorKind, message: S) -> ProtocolError {
ProtocolError {
kind,
message: message.into(),
}
}
}
/// Runtime library error categories.
///
/// This list may grow, and it is not recommended to match against it.
#[non_exhaustive]
#[derive(Clone, Copy, Eq, Debug, PartialEq)]
pub enum ProtocolErrorKind {
/// Catch-all runtime-library error.
Unknown = 0,
/// An invalid argument was supplied to a library function, or invalid data
/// was received from a Thrift endpoint.
InvalidData = 1,
/// An invalid size was received in an encoded field.
NegativeSize = 2,
/// Thrift message or field was too long.
SizeLimit = 3,
/// Unsupported or unknown Thrift protocol version.
BadVersion = 4,
/// Unsupported Thrift protocol, server or field type.
NotImplemented = 5,
/// Reached the maximum nested depth to which an encoded Thrift field could
/// be skipped.
DepthLimit = 6,
}
impl Display for ProtocolError {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
let error_text = match self.kind {
ProtocolErrorKind::Unknown => "protocol error",
ProtocolErrorKind::InvalidData => "bad data",
ProtocolErrorKind::NegativeSize => "negative message size",
ProtocolErrorKind::SizeLimit => "message too long",
ProtocolErrorKind::BadVersion => "invalid thrift version",
ProtocolErrorKind::NotImplemented => "not implemented",
ProtocolErrorKind::DepthLimit => "maximum skip depth reached",
};
write!(f, "{}", error_text)
}
}
impl TryFrom<i32> for ProtocolErrorKind {
type Error = Error;
fn try_from(from: i32) -> Result<Self, Self::Error> {
match from {
0 => Ok(ProtocolErrorKind::Unknown),
1 => Ok(ProtocolErrorKind::InvalidData),
2 => Ok(ProtocolErrorKind::NegativeSize),
3 => Ok(ProtocolErrorKind::SizeLimit),
4 => Ok(ProtocolErrorKind::BadVersion),
5 => Ok(ProtocolErrorKind::NotImplemented),
6 => Ok(ProtocolErrorKind::DepthLimit),
_ => Err(Error::Protocol(ProtocolError {
kind: ProtocolErrorKind::Unknown,
message: format!("cannot convert {} to ProtocolErrorKind", from),
})),
}
}
}
/// Create a new `Error` instance of type `Application` that wraps an
/// `ApplicationError`.
pub fn new_application_error<S: Into<String>>(kind: ApplicationErrorKind, message: S) -> Error {
Error::Application(ApplicationError::new(kind, message))
}
/// Information about errors in auto-generated code or in user-implemented
/// service handlers.
#[derive(Debug, Eq, PartialEq)]
pub struct ApplicationError {
/// Application error variant.
///
/// If a specific `ApplicationErrorKind` does not apply use
/// `ApplicationErrorKind::Unknown`.
pub kind: ApplicationErrorKind,
/// Human-readable error message.
pub message: String,
}
impl ApplicationError {
/// Create a new `ApplicationError`.
pub fn new<S: Into<String>>(kind: ApplicationErrorKind, message: S) -> ApplicationError {
ApplicationError {
kind,
message: message.into(),
}
}
}
/// Auto-generated or user-implemented code error categories.
///
/// This list may grow, and it is not recommended to match against it.
#[non_exhaustive]
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ApplicationErrorKind {
/// Catch-all application error.
Unknown = 0,
/// Made service call to an unknown service method.
UnknownMethod = 1,
/// Received an unknown Thrift message type. That is, not one of the
/// `thrift::protocol::TMessageType` variants.
InvalidMessageType = 2,
/// Method name in a service reply does not match the name of the
/// receiving service method.
WrongMethodName = 3,
/// Received an out-of-order Thrift message.
BadSequenceId = 4,
/// Service reply is missing required fields.
MissingResult = 5,
/// Auto-generated code failed unexpectedly.
InternalError = 6,
/// Thrift protocol error. When possible use `Error::ProtocolError` with a
/// specific `ProtocolErrorKind` instead.
ProtocolError = 7,
/// *Unknown*. Included only for compatibility with existing Thrift implementations.
InvalidTransform = 8, // ??
/// Thrift endpoint requested, or is using, an unsupported encoding.
InvalidProtocol = 9, // ??
/// Thrift endpoint requested, or is using, an unsupported auto-generated client type.
UnsupportedClientType = 10, // ??
}
impl Display for ApplicationError {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
let error_text = match self.kind {
ApplicationErrorKind::Unknown => "service error",
ApplicationErrorKind::UnknownMethod => "unknown service method",
ApplicationErrorKind::InvalidMessageType => "wrong message type received",
ApplicationErrorKind::WrongMethodName => "unknown method reply received",
ApplicationErrorKind::BadSequenceId => "out of order sequence id",
ApplicationErrorKind::MissingResult => "missing method result",
ApplicationErrorKind::InternalError => "remote service threw exception",
ApplicationErrorKind::ProtocolError => "protocol error",
ApplicationErrorKind::InvalidTransform => "invalid transform",
ApplicationErrorKind::InvalidProtocol => "invalid protocol requested",
ApplicationErrorKind::UnsupportedClientType => "unsupported protocol client",
};
write!(f, "{}", error_text)
}
}
impl TryFrom<i32> for ApplicationErrorKind {
type Error = Error;
fn try_from(from: i32) -> Result<Self, Self::Error> {
match from {
0 => Ok(ApplicationErrorKind::Unknown),
1 => Ok(ApplicationErrorKind::UnknownMethod),
2 => Ok(ApplicationErrorKind::InvalidMessageType),
3 => Ok(ApplicationErrorKind::WrongMethodName),
4 => Ok(ApplicationErrorKind::BadSequenceId),
5 => Ok(ApplicationErrorKind::MissingResult),
6 => Ok(ApplicationErrorKind::InternalError),
7 => Ok(ApplicationErrorKind::ProtocolError),
8 => Ok(ApplicationErrorKind::InvalidTransform),
9 => Ok(ApplicationErrorKind::InvalidProtocol),
10 => Ok(ApplicationErrorKind::UnsupportedClientType),
_ => Err(Error::Application(ApplicationError {
kind: ApplicationErrorKind::Unknown,
message: format!("cannot convert {} to ApplicationErrorKind", from),
})),
}
}
}