pilota 0.13.0

Pilota is a thrift and protobuf implementation in pure rust with high performance and extensibility.
Documentation 
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

use std::fmt::{self, Display, Formatter};

use faststr::FastStr;

use crate::msg_impl;

#[deprecated(
    since = "0.11.0",
    note = "Please use the `ProtocolException` instead. This type will be removed in the next release."
)]
pub type ProtocolError = ProtocolException;

/// Information about errors that occur in the runtime library.
///
/// This exception does not send across endpoints, so seems that it is
/// not necessary to keep it in sync with other languages.
#[derive(Debug, Eq, PartialEq, Clone)]
pub struct ProtocolException {
    /// Protocol error variant.
    ///
    /// If a specific `ProtocolExceptionKind` does not apply use
    /// `ProtocolExceptionKind::Unknown`.
    kind: ProtocolExceptionKind,
    /// Human-readable error message.
    message: FastStr,
}

impl ProtocolException {
    /// Create a new `ProtocolError`.
    pub fn new<S: Into<FastStr>>(kind: ProtocolExceptionKind, message: S) -> ProtocolException {
        ProtocolException {
            kind,
            message: message.into(),
        }
    }

    /// Get the error kind.
    #[inline]
    pub fn kind(&self) -> ProtocolExceptionKind {
        self.kind
    }

    /// Get the error message.
    #[inline]
    pub fn message(&self) -> &FastStr {
        &self.message
    }

    msg_impl!();
}

impl Display for ProtocolException {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        let error_text = match self.kind {
            ProtocolExceptionKind::Unknown => "protocol error",
            ProtocolExceptionKind::InvalidData => "bad data",
            ProtocolExceptionKind::NegativeSize => "negative message size",
            ProtocolExceptionKind::SizeLimit => "message too long",
            ProtocolExceptionKind::BadVersion => "invalid thrift version",
            ProtocolExceptionKind::NotImplemented => "not implemented",
            ProtocolExceptionKind::DepthLimit => "maximum skip depth reached",
        };

        write!(f, "{}: {}", error_text, self.message)
    }
}

impl std::error::Error for ProtocolException {}

#[deprecated(
    since = "0.11.0",
    note = "Please use the `ProtocolExceptionKind` instead. This type will be removed in the next release."
)]
pub type ProtocolErrorKind = ProtocolExceptionKind;

/// 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 ProtocolExceptionKind {
    /// Catch-all runtime-library error.
    Unknown,
    /// An invalid argument was supplied to a library function, or invalid data
    /// was received from a Thrift endpoint.
    InvalidData,
    /// An invalid size was received in an encoded field.
    NegativeSize,
    /// Thrift message or field was too long.
    SizeLimit,
    /// Unsupported or unknown Thrift protocol version.
    BadVersion,
    /// Unsupported Thrift protocol, server or field type.
    NotImplemented,
    /// Reached the maximum nested depth to which an encoded Thrift field could
    /// be skipped.
    DepthLimit,
}