131 lines
3.9 KiB
C++
131 lines
3.9 KiB
C++
// Protocol Buffers - Google's data interchange format
|
|
// Copyright 2008 Google Inc. All rights reserved.
|
|
// https://developers.google.com/protocol-buffers/
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are
|
|
// met:
|
|
//
|
|
// * Redistributions of source code must retain the above copyright
|
|
// notice, this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above
|
|
// copyright notice, this list of conditions and the following disclaimer
|
|
// in the documentation and/or other materials provided with the
|
|
// distribution.
|
|
// * Neither the name of Google Inc. nor the names of its
|
|
// contributors may be used to endorse or promote products derived from
|
|
// this software without specific prior written permission.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
#ifndef GOOGLE_PROTOBUF_STUBS_STATUS_H_
|
|
#define GOOGLE_PROTOBUF_STUBS_STATUS_H_
|
|
|
|
#include <iosfwd>
|
|
#include <string>
|
|
|
|
#include <google/protobuf/stubs/common.h>
|
|
#include <google/protobuf/stubs/stringpiece.h>
|
|
|
|
#include <google/protobuf/port_def.inc>
|
|
|
|
namespace google {
|
|
namespace protobuf {
|
|
namespace util {
|
|
namespace error {
|
|
// These values must match error codes defined in google/rpc/code.proto.
|
|
enum Code {
|
|
OK = 0,
|
|
CANCELLED = 1,
|
|
UNKNOWN = 2,
|
|
INVALID_ARGUMENT = 3,
|
|
DEADLINE_EXCEEDED = 4,
|
|
NOT_FOUND = 5,
|
|
ALREADY_EXISTS = 6,
|
|
PERMISSION_DENIED = 7,
|
|
UNAUTHENTICATED = 16,
|
|
RESOURCE_EXHAUSTED = 8,
|
|
FAILED_PRECONDITION = 9,
|
|
ABORTED = 10,
|
|
OUT_OF_RANGE = 11,
|
|
UNIMPLEMENTED = 12,
|
|
INTERNAL = 13,
|
|
UNAVAILABLE = 14,
|
|
DATA_LOSS = 15,
|
|
};
|
|
} // namespace error
|
|
|
|
struct StatusPod {
|
|
error::Code code;
|
|
};
|
|
|
|
class PROTOBUF_EXPORT Status {
|
|
public:
|
|
// Creates a "successful" status.
|
|
Status();
|
|
|
|
// Create a status in the canonical error space with the specified
|
|
// code, and error message. If "code == 0", error_message is
|
|
// ignored and a Status object identical to Status::OK is
|
|
// constructed.
|
|
Status(error::Code error_code, StringPiece error_message);
|
|
Status(const Status&);
|
|
Status(const StatusPod&);
|
|
Status& operator=(const Status& x);
|
|
~Status() {}
|
|
|
|
// Some pre-defined Status objects
|
|
static const StatusPod OK;
|
|
static const StatusPod CANCELLED;
|
|
static const StatusPod UNKNOWN;
|
|
|
|
// Accessor
|
|
bool ok() const {
|
|
return error_code_ == error::OK;
|
|
}
|
|
int error_code() const {
|
|
return error_code_;
|
|
}
|
|
error::Code code() const {
|
|
return error_code_;
|
|
}
|
|
StringPiece error_message() const {
|
|
return error_message_;
|
|
}
|
|
StringPiece message() const {
|
|
return error_message_;
|
|
}
|
|
|
|
bool operator==(const Status& x) const;
|
|
bool operator!=(const Status& x) const {
|
|
return !operator==(x);
|
|
}
|
|
|
|
// Return a combination of the error code name and message.
|
|
string ToString() const;
|
|
|
|
private:
|
|
error::Code error_code_;
|
|
string error_message_;
|
|
};
|
|
|
|
// Prints a human-readable representation of 'x' to 'os'.
|
|
PROTOBUF_EXPORT std::ostream& operator<<(std::ostream& os, const Status& x);
|
|
|
|
} // namespace util
|
|
} // namespace protobuf
|
|
} // namespace google
|
|
|
|
#include <google/protobuf/port_undef.inc>
|
|
|
|
#endif // GOOGLE_PROTOBUF_STUBS_STATUS_H_
|