Return type for API calls. More...

#include <return_types.hpp>

Public Member Functions
	operator bool () const
	Returns true if answer::error_code is 0, false otherwise. More...

	operator string_view () const
	Returns answer::body as std::string_view. More...

Public Attributes
uint8_t	error_code
	Error code. More...

string	error_message
	The error message. More...

uint16_t	http_status
	HTTP status code. More...

string	body
	The response from the server, usually JSON. More...

Friends
std::ostream &	operator<< (std::ostream &out, const answer &answer)
	Returns answer::body as std::ostream. More...

Detailed Description

Return type for API calls.

Since: 0.1.0

Error codes

Code	Explanation
0	No error.

Member Function Documentation

◆ operator bool()

mastodonpp::answer::operator bool ( ) const

explicit

Returns true if answer::error_code is 0, false otherwise.

Since: 0.1.0

 {
     return (error_code == 0);
 }

◆ operator string_view()

mastodonpp::answer::operator string_view ( ) const

explicit

Returns answer::body as std::string_view.

Since: 0.1.0

 {
     return body;
 }

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	out,
		const answer &	answer
	)

friend

Returns answer::body as std::ostream.

Since: 0.1.0

 {
     out << answer.body;
     return out;
 }

Member Data Documentation

◆ body

string mastodonpp::answer::body

The response from the server, usually JSON.

Since: 0.1.0

◆ error_code

uint8_t mastodonpp::answer::error_code

Error code.

Since: 0.1.0

◆ error_message

string mastodonpp::answer::error_message

The error message.

Since: 0.1.0

◆ http_status

uint16_t mastodonpp::answer::http_status

HTTP status code.

Since: 0.1.0

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

include/return_types.hpp
src/return_types.cpp

Public Member Functions

Public Attributes

Friends