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
/// Get from github.com/gogo/googleapis/google/rpc/code.proto
/// The canonical error codes for Google APIs.
///
///
/// Sometimes multiple error codes may apply. Services should return
/// the most specific error code that applies. For example, prefer
/// `OUT_OF_RANGE` over `FAILED_PRECONDITION` if both codes apply.
/// Similarly prefer `NOT_FOUND` or `ALREADY_EXISTS` over `FAILED_PRECONDITION`.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, prost::Enumeration)]
#[repr(i32)]
pub enum Code {
/// Not an error; returned on success
///
/// HTTP Mapping: 200 OK
Ok = 0,
/// The operation was cancelled, typically by the caller.
///
/// HTTP Mapping: 499 Client Closed Request
Cancelled = 1,
/// Unknown error. For example, this error may be returned when
/// a `Status` value received from another address space belongs to
/// an error space that is not known in this address space. Also
/// errors raised by APIs that do not return enough error information
/// may be converted to this error.
///
/// HTTP Mapping: 500 Internal Server Error
Unknown = 2,
/// The client specified an invalid argument. Note that this differs
/// from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments
/// that are problematic regardless of the state of the system
/// (e.g., a malformed file name).
///
/// HTTP Mapping: 400 Bad Request
InvalidArgument = 3,
/// The deadline expired before the operation could complete. For operations
/// that change the state of the system, this error may be returned
/// even if the operation has completed successfully. For example, a
/// successful response from a server could have been delayed long
/// enough for the deadline to expire.
///
/// HTTP Mapping: 504 Gateway Timeout
DeadlineExceeded = 4,
/// Some requested entity (e.g., file or directory) was not found.
///
/// Note to server developers: if a request is denied for an entire class
/// of users, such as gradual feature rollout or undocumented whitelist,
/// `NOT_FOUND` may be used. If a request is denied for some users within
/// a class of users, such as user-based access control, `PERMISSION_DENIED`
/// must be used.
///
/// HTTP Mapping: 404 Not Found
NotFound = 5,
/// The entity that a client attempted to create (e.g., file or directory)
/// already exists.
///
/// HTTP Mapping: 409 Conflict
AlreadyExists = 6,
/// The caller does not have permission to execute the specified
/// operation. `PERMISSION_DENIED` must not be used for rejections
/// caused by exhausting some resource (use `RESOURCE_EXHAUSTED`
/// instead for those errors). `PERMISSION_DENIED` must not be
/// used if the caller can not be identified (use `UNAUTHENTICATED`
/// instead for those errors). This error code does not imply the
/// request is valid or the requested entity exists or satisfies
/// other pre-conditions.
///
/// HTTP Mapping: 403 Forbidden
PermissionDenied = 7,
/// The request does not have valid authentication credentials for the
/// operation.
///
/// HTTP Mapping: 401 Unauthorized
Unauthenticated = 16,
/// Some resource has been exhausted, perhaps a per-user quota, or
/// perhaps the entire file system is out of space.
///
/// HTTP Mapping: 429 Too Many Requests
ResourceExhausted = 8,
/// The operation was rejected because the system is not in a state
/// required for the operation's execution. For example, the directory
/// to be deleted is non-empty, an rmdir operation is applied to
/// a non-directory, etc.
///
/// Service implementors can use the following guidelines to decide
/// between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:
/// (a) Use `UNAVAILABLE` if the client can retry just the failing call.
/// (b) Use `ABORTED` if the client should retry at a higher level
/// (e.g., when a client-specified test-and-set fails, indicating the
/// client should restart a read-modify-write sequence).
/// (c) Use `FAILED_PRECONDITION` if the client should not retry until
/// the system state has been explicitly fixed. E.g., if an "rmdir"
/// fails because the directory is non-empty, `FAILED_PRECONDITION`
/// should be returned since the client should not retry unless
/// the files are deleted from the directory.
///
/// HTTP Mapping: 400 Bad Request
FailedPrecondition = 9,
/// The operation was aborted, typically due to a concurrency issue such as
/// a sequencer check failure or transaction abort.
///
/// See the guidelines above for deciding between `FAILED_PRECONDITION`,
/// `ABORTED`, and `UNAVAILABLE`.
///
/// HTTP Mapping: 409 Conflict
Aborted = 10,
/// The operation was attempted past the valid range. E.g., seeking or
/// reading past end-of-file.
///
/// Unlike `INVALID_ARGUMENT`, this error indicates a problem that may
/// be fixed if the system state changes. For example, a 32-bit file
/// system will generate `INVALID_ARGUMENT` if asked to read at an
/// offset that is not in the range \[0,2^32-1\], but it will generate
/// `OUT_OF_RANGE` if asked to read from an offset past the current
/// file size.
///
/// There is a fair bit of overlap between `FAILED_PRECONDITION` and
/// `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific
/// error) when it applies so that callers who are iterating through
/// a space can easily look for an `OUT_OF_RANGE` error to detect when
/// they are done.
///
/// HTTP Mapping: 400 Bad Request
OutOfRange = 11,
/// The operation is not implemented or is not supported/enabled in this
/// service.
///
/// HTTP Mapping: 501 Not Implemented
Unimplemented = 12,
/// Internal errors. This means that some invariants expected by the
/// underlying system have been broken. This error code is reserved
/// for serious errors.
///
/// HTTP Mapping: 500 Internal Server Error
Internal = 13,
/// The service is currently unavailable. This is most likely a
/// transient condition, which can be corrected by retrying with
/// a backoff.
///
/// See the guidelines above for deciding between `FAILED_PRECONDITION`,
/// `ABORTED`, and `UNAVAILABLE`.
///
/// HTTP Mapping: 503 Service Unavailable
Unavailable = 14,
/// Unrecoverable data loss or corruption.
///
/// HTTP Mapping: 500 Internal Server Error
DataLoss = 15,
}
impl Code {
/// String value of the enum field names used in the protobuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the protobuf definition does not change) and safe for programmatic use.
#[must_use]
pub fn as_str_name(&self) -> &'static str {
match self {
Code::Ok => "OK",
Code::Cancelled => "CANCELLED",
Code::Unknown => "UNKNOWN",
Code::InvalidArgument => "INVALID_ARGUMENT",
Code::DeadlineExceeded => "DEADLINE_EXCEEDED",
Code::NotFound => "NOT_FOUND",
Code::AlreadyExists => "ALREADY_EXISTS",
Code::PermissionDenied => "PERMISSION_DENIED",
Code::Unauthenticated => "UNAUTHENTICATED",
Code::ResourceExhausted => "RESOURCE_EXHAUSTED",
Code::FailedPrecondition => "FAILED_PRECONDITION",
Code::Aborted => "ABORTED",
Code::OutOfRange => "OUT_OF_RANGE",
Code::Unimplemented => "UNIMPLEMENTED",
Code::Internal => "INTERNAL",
Code::Unavailable => "UNAVAILABLE",
Code::DataLoss => "DATA_LOSS",
}
}
/// Creates an enum from field names used in the protobuf definition.
#[must_use]
pub fn from_str_name(value: &str) -> Option<Self> {
match value {
"OK" => Some(Self::Ok),
"CANCELLED" => Some(Self::Cancelled),
"UNKNOWN" => Some(Self::Unknown),
"INVALID_ARGUMENT" => Some(Self::InvalidArgument),
"DEADLINE_EXCEEDED" => Some(Self::DeadlineExceeded),
"NOT_FOUND" => Some(Self::NotFound),
"ALREADY_EXISTS" => Some(Self::AlreadyExists),
"PERMISSION_DENIED" => Some(Self::PermissionDenied),
"UNAUTHENTICATED" => Some(Self::Unauthenticated),
"RESOURCE_EXHAUSTED" => Some(Self::ResourceExhausted),
"FAILED_PRECONDITION" => Some(Self::FailedPrecondition),
"ABORTED" => Some(Self::Aborted),
"OUT_OF_RANGE" => Some(Self::OutOfRange),
"UNIMPLEMENTED" => Some(Self::Unimplemented),
"INTERNAL" => Some(Self::Internal),
"UNAVAILABLE" => Some(Self::Unavailable),
"DATA_LOSS" => Some(Self::DataLoss),
_ => None,
}
}
}