- +

kudu::Status Class Reference

A representation of an operation's outcome. - More...

#include <status.h>

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions
-	Status ()
	Create an object representing success status.

	Status (const Status &s)

void	operator= (const Status &s)

bool	ok () const

bool	IsNotFound () const

bool	IsCorruption () const

bool	IsNotSupported () const

bool	IsIOError () const

bool	IsInvalidArgument () const

bool	IsAlreadyPresent () const

bool	IsRuntimeError () const

bool	IsNetworkError () const

bool	IsIllegalState () const

bool	IsNotAuthorized () const

bool	IsAborted () const

bool	IsRemoteError () const

bool	IsServiceUnavailable () const

bool	IsTimedOut () const

bool	IsUninitialized () const

bool	IsConfigurationError () const

bool	IsIncomplete () const

bool	IsEndOfFile () const

std::string	ToString () const

std::string	CodeAsString () const

Slice	message () const

int16_t	posix_code () const

Status	CloneAndPrepend (const Slice &msg) const

Status	CloneAndAppend (const Slice &msg) const

size_t	memory_footprint_excluding_this () const

size_t	memory_footprint_including_this () const

- - - + +

List of all members.

+

-Static Public Member Functions
static Status	OK ()

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -

Public Member Functions

+ Status ()

Create an object representing success status.

Status (const Status &s)

void operator= (const Status &s)

bool ok () const

bool IsNotFound () const

bool IsCorruption () const

bool IsNotSupported () const

bool IsIOError () const

bool IsInvalidArgument () const

bool IsAlreadyPresent () const

bool IsRuntimeError () const

bool IsNetworkError () const

bool IsIllegalState () const

bool IsNotAuthorized () const

bool IsAborted () const

bool IsRemoteError () const

bool IsServiceUnavailable () const

bool IsTimedOut () const

bool IsUninitialized () const

bool IsConfigurationError () const

bool IsIncomplete () const

bool IsEndOfFile () const

std::string ToString () const

std::string CodeAsString () const

Slice message () const

int16_t posix_code () const

Status CloneAndPrepend (const Slice &msg) const

Status CloneAndAppend (const Slice &msg) const

size_t memory_footprint_excluding_this () const

size_t memory_footprint_including_this () const

Static Public Member Functions

static Status OK ()

Methods to build status objects for various types of errors.

Parameters

- - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +

Returns:: The error status of an appropriate type.

+

+ + + + + + + + + + + + + + + + + +

[in] msg The informational message on the error.

[in] msg2 Additional information on the error (optional).

[in] posix_code POSIX error code, if applicable (optional).

+

Parameters:

+ + + +

`[in]`	msg	The informational message on the error.
`[in]`	msg2	Additional information on the error (optional).
`[in]`	posix_code	POSIX error code, if applicable (optional).

-

Returns: The error status of an appropriate type.

-

-static Status NotFound (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status Corruption (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status NotSupported (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status InvalidArgument (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status IOError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status AlreadyPresent (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status RuntimeError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status NetworkError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status IllegalState (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status NotAuthorized (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status Aborted (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status RemoteError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status ServiceUnavailable (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status TimedOut (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status Uninitialized (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status ConfigurationError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

-static Status Incomplete (const Slice &msg, const Slice &msg2=Slice(), int64_t posix_code=-1)

-static Status EndOfFile (const Slice &msg, const Slice &msg2=Slice(), int64_t posix_code=-1)

+static Status NotFound (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status Corruption (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status NotSupported (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status InvalidArgument (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status IOError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status AlreadyPresent (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status RuntimeError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status NetworkError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status IllegalState (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status NotAuthorized (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status Aborted (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status RemoteError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status ServiceUnavailable (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status TimedOut (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status Uninitialized (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status ConfigurationError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)

+static Status Incomplete (const Slice &msg, const Slice &msg2=Slice(), int64_t posix_code=-1)

+static Status EndOfFile (const Slice &msg, const Slice &msg2=Slice(), int64_t posix_code=-1)

-

Detailed Description

-

A representation of an operation's outcome.

-

Constructor & Destructor Documentation

- +

Detailed Description

+

A representation of an operation's outcome.

+

Constructor & Destructor Documentation

+

- - - - - -

- - - + + + +

kudu::Status::Status ( const Status & s ) const Status & s ) [inline]

-

-inline

-

+

Copy the specified status.

-

Parameters

- - +

Parameters:: +

[in] s The status object to copy from.

+

[in] s The status object to copy from.

-

Member Function Documentation

- +

Member Function Documentation

+

- - + + +

Status kudu::Status::CloneAndAppend ( const Slice & msg ) const Slice & msg ) const

-

+

Clone the object and add the specified suffix to the clone's message.

-

Parameters

- - +

Parameters:: +

[in] msg The message to append.

+

[in] msg The message to append.

-

Returns: A new Status object with the same state plus an additional trailing message.

+

Returns:: A new Status object with the same state plus an additional trailing message.

- +

- - + + +

Status kudu::Status::CloneAndPrepend ( const Slice & msg ) const Slice & msg ) const

-

+

Clone the object and add the specified prefix to the clone's message.

-

Parameters

- - +

Parameters:: +

[in] msg The message to prepend.

+

[in] msg The message to prepend.

-

Returns: A new Status object with the same state plus an additional leading message.

+

Returns:: A new Status object with the same state plus an additional leading message.

- +

- + +

std::string kudu::Status::CodeAsString ( ) ) const

-

Returns: A string representation of the status code, without the message text or posix code information.

+

Returns:: A string representation of the status code, without the message text or posix code information.

- +

- - - - - -

- - + + +

bool kudu::Status::IsAborted ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates an Aborted error.

+

Returns:: true iff the status indicates an Aborted error.

- +

- - - - - -

- - + + +

bool kudu::Status::IsAlreadyPresent ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates an AlreadyPresent error.

+

Returns:: true iff the status indicates an AlreadyPresent error.

- +

- - - - - -

- - + + +

bool kudu::Status::IsConfigurationError ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates ConfigurationError.

+

Returns:: true iff the status indicates ConfigurationError.

- +

- - - - - -

- - + + +

bool kudu::Status::IsCorruption ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates a Corruption error.

+

Returns:: true iff the status indicates a Corruption error.

- +

- - - - - -

- - + + +

bool kudu::Status::IsEndOfFile ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates end of file.

+

Returns:: true iff the status indicates end of file.

- +

- - - - - -

- - + + +

bool kudu::Status::IsIllegalState ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates an IllegalState error.

+

Returns:: true iff the status indicates an IllegalState error.

- +

- - - - - -

- - + + +

bool kudu::Status::IsIncomplete ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates Incomplete.

+

Returns:: true iff the status indicates Incomplete.

- +

- - - - - -

- - + + +

bool kudu::Status::IsInvalidArgument ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates an InvalidArgument error.

+

Returns:: true iff the status indicates an InvalidArgument error.

- +

- - - - - -

- - + + +

bool kudu::Status::IsIOError ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates an IOError.

+

Returns:: true iff the status indicates an IOError.

- +

- - - - - -

- - + + +

bool kudu::Status::IsNetworkError ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates a NetworkError.

+

Returns:: true iff the status indicates a NetworkError.

- +

- - - - - -

- - + + +

bool kudu::Status::IsNotAuthorized ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates a NotAuthorized error.

+

Returns:: true iff the status indicates a NotAuthorized error.

- +

- - - - - -

- - + + +

bool kudu::Status::IsNotFound ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates a NotFound error.

+

Returns:: true iff the status indicates a NotFound error.

- +

- - - - - -

- - + + +

bool kudu::Status::IsNotSupported ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates a NotSupported error.

+

Returns:: true iff the status indicates a NotSupported error.

- +

- - - - - -

- - + + +

bool kudu::Status::IsRemoteError ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates a RemoteError.

+

Returns:: true iff the status indicates a RemoteError.

- +

- - - - - -

- - + + +

bool kudu::Status::IsRuntimeError ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates a RuntimeError.

+

Returns:: true iff the status indicates a RuntimeError.

- +

- - - - - -

- - + + +

bool kudu::Status::IsServiceUnavailable ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates ServiceUnavailable.

+

Returns:: true iff the status indicates ServiceUnavailable.

- +

- - - - - -

- - + + +

bool kudu::Status::IsTimedOut ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates TimedOut.

+

Returns:: true iff the status indicates TimedOut.

- +

- - - - - -

- - + + +

bool kudu::Status::IsUninitialized ( ) const ) const [inline]

-

-inline

-

Returns: true iff the status indicates Uninitialized.

+

Returns:: true iff the status indicates Uninitialized.

- +

- + +

size_t kudu::Status::memory_footprint_excluding_this ( ) ) const

-

Returns: The memory usage of this object without the object itself. Should be used when embedded inside another object.

+

Returns:: The memory usage of this object without the object itself. Should be used when embedded inside another object.

- +

- + +

size_t kudu::Status::memory_footprint_including_this ( ) ) const

-

Returns: The memory usage of this object including the object itself. Should be used when allocated on the heap.

+

Returns:: The memory usage of this object including the object itself. Should be used when allocated on the heap.

- +

- + +

Slice kudu::Status::message ( ) ) const

-

+

This is similar to ToString, except that it does not include the stringified error code or posix code.

-

Note: The returned Slice is only valid as long as this Status object remains live and unchanged.

-

Returns: The message portion of the Status. For OK statuses, this returns an empty string.

+

Note:: The returned Slice is only valid as long as this Status object remains live and unchanged.

+

Returns:: The message portion of the Status. For OK statuses, this returns an empty string.

- +

- - - - - -

- + - - + + +

static Status kudu::Status::OK bool kudu::Status::ok ( ) ) const [inline]

-

-inlinestatic

-

Returns: A success status.

+

Returns:: true iff the status indicates success.

- +

kudu::Status Class Reference

-Public Member Functions

-Static Public Member Functions

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Function Documentation