api-client/error__response_8h_source.html

#ifndef OCTANE_API_CLIENT_ERROR_RESPONSE_H_

#define OCTANE_API_CLIENT_ERROR_RESPONSE_H_


#include <string>

#include <string_view>


#include "./result.h"


namespace octane {

  struct ErrorResponse {

    std::string code;

    std::string reason;

  };

  error_t<ErrorResponse> makeError(std::string_view code,

                                   std::string_view reason);

  bool operator==(const ErrorResponse& a, const ErrorResponse& b);

  std::ostream& operator<<(std::ostream& stream, const ErrorResponse& err);

} // namespace octane

#endif // OCTANE_API_CLIENT_ERROR_RESPONSE_H_

octane::error_t
Utility class that can be used when we only want to specify quasi-normal state types.
Definition: result.h:310

octane
Definition: api_client.cpp:20

octane::err
decltype(auto) err(T_Error &&error)
Utility function to construct quasi-normal state values.
Definition: result.h:388

octane::makeError
error_t< ErrorResponse > makeError(std::string_view code, std::string_view reason)
Utility function to create error response.
Definition: error_response.cpp:16

octane::operator<<
std::ostream & operator<<(std::ostream &stream, const HealthResult &healthResult)
Definition: api_result_types.cpp:18

octane::operator==
bool operator==(const HealthResult &a, const HealthResult &b)
Definition: api_result_types.cpp:15

result.h
Define type to represent the result, inspired by Rust's "Result".

octane::ErrorResponse
General stucture to represent the error.
Definition: error_response.h:24

octane::ErrorResponse::code
std::string code
Error code.
Definition: error_response.h:33

octane::ErrorResponse::reason
std::string reason
Reason why the error ocurred.
Definition: error_response.h:45