Mastodon::return_call Struct Reference

Return type for API calls. More...

#include <return_types.hpp>

Inheritance diagram for Mastodon::return_call:

Public Member Functions
	return_call (const uint8_t ec, const string &em, const uint16_t hec, const string &a)
	Return type for Mastodon::API. More...
	return_call (const error ec, const string &em, const uint16_t hec, const string &a)
	Return type for Mastodon::API. More...
	operator const string () const
	Same es return_call::answer. More...
Public Member Functions inherited from Mastodon::return_base
	operator bool () const
	true if return_base::error_code is 0, otherwise false. More...
	operator uint8_t () const
	Same as return_base::error_code. More...

Public Attributes
string	answer
	The response from the server. More...
Public Attributes inherited from Mastodon::return_base
uint8_t	error_code = 0
	Error code. More...
string	error_message
	The error message, or "". More...
uint16_t	http_error_code = 0
	HTTP error code. More...

Friends
std::ostream &	operator<< (std::ostream &out, const return_call &ret)
	Same es return_call::answer. More...

Detailed Description

Return type for API calls.

Example:

Mastodon::return_call ret = masto.get(Mastodon::API::v1::instance);
if (!ret)               // Or ret.error_code != 0
{
    cout << "Error " << std::to_string(ret.error_code);
    cout << " (HTTP " << std::to_string(ret.http_error_code) << "): ";
    cout << ret.error_message << endl
}
else
{
    cout << ret << endl; // Or ret.answer
}

Since

0.100.0

Examples

example01_get_public_timeline.cpp.

Constructor & Destructor Documentation

return_call() [1/2]

Mastodon::return_call::return_call	(	const uint8_t	ec,
		const string &	em,
		const uint16_t	hec,
		const string &	a
	)

Return type for Mastodon::API.

Parameters

ec	Error code
em	Error message
hec	HTTP error code
a	Answer

Since

0.100.0

        : answer(a)
    {
        error_code = ec;
        error_message = em;
        http_error_code = hec;
    }

return_call() [2/2]

Mastodon::return_call::return_call	(	const error	ec,
		const string &	em,
		const uint16_t	hec,
		const string &	a
	)

Return type for Mastodon::API.

Parameters

ec	Error code
em	Error message
hec	HTTP error code
a	Answer

Since

0.110.0

        : answer(a)
    {
        error_code = static_cast<uint8_t>(ec);
        error_message = em;
        http_error_code = hec;
    }

Member Function Documentation

operator const string()

Mastodon::return_call::operator const string

(

)

const

Same es return_call::answer.

Since

0.100.0

    {
        return answer;
    }

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  out, const return_call &  ret  )

friend

Same es return_call::answer.

Since

0.100.0

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

Member Data Documentation

answer

string Mastodon::return_call::answer

The response from the server.

Since

0.100.0

Examples

example01_get_public_timeline.cpp.

---

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

• src/return_types.hpp
• src/return_types.cpp