Class of statuses. More...

#include <msgpack_rpc/common/status.h>

Collaboration diagram for msgpack_rpc::common::Status:

Classes
struct	Data
	Internal data. More...

Public Member Functions
	Status () noexcept
	Constructor. (Set to success.)
	Status (const Status &) noexcept
	Copy constructor.
	Status (Status &&) noexcept
	Move constructor.
	Status (StatusCode code, std::string_view message)
	Constructor.
	~Status () noexcept
	Destructor.
StatusCode	code () const noexcept
	Get the status code.
std::string_view	message () const noexcept
	Get the error message.
Status &	operator= (const Status &) noexcept
	Copy assignment operator.
Status &	operator= (Status &&) noexcept
	Move assignment operator.

Private Attributes
std::shared_ptr< Data >	data_
	Internal data.

Detailed Description

Class of statuses.

Definition at line 34 of file status.h.

Constructor & Destructor Documentation

◆ Status()

msgpack_rpc::common::Status::Status	(	StatusCode	code,
		std::string_view	message )

Constructor.

Parameters

[in]	code	Status code.
[in]	message	Error message.

Definition at line 56 of file status.cpp.

Member Function Documentation

◆ code()

StatusCode msgpack_rpc::common::Status::code ( ) const

nodiscardnoexcept

Get the status code.

Returns: Status code.

Definition at line 69 of file status.cpp.

◆ message()

std::string_view msgpack_rpc::common::Status::message ( ) const

nodiscardnoexcept

Get the error message.

Returns: Error message.

Note: This returns empty message when this status is not an error.

Definition at line 76 of file status.cpp.

◆ operator=() [1/2]

Status & msgpack_rpc::common::Status::operator= ( const Status & )

defaultnoexcept

Copy assignment operator.

Returns: This.

◆ operator=() [2/2]

Status & msgpack_rpc::common::Status::operator= ( Status && )

defaultnoexcept

Move assignment operator.

Returns: This.

Member Data Documentation

◆ data_

std::shared_ptr<Data> msgpack_rpc::common::Status::data_

private

Internal data.

Definition at line 99 of file status.h.

The documentation for this class was generated from the following files:

include/msgpack_rpc/common/status.h
src/msgpack_rpc/common/status.cpp

Classes

Public Member Functions

Private Attributes