Mastodon::return_base Struct Reference

Basis for return types. More...

#include <return_types.hpp>

Inheritance diagram for Mastodon::return_base:

Public Member Functions
	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
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...

Detailed Description

Basis for return types.

Since

0.100.0

Member Function Documentation

operator bool()

Mastodon::return_base::operator bool

(

)

const

true if return_base::error_code is 0, otherwise false.

Since

0.100.0

    {
        if (error_code == 0)
        {
            return true;
        }
        else
        {
            return false;
        }
    }

operator uint8_t()

Mastodon::return_base::operator uint8_t

(

)

const

Same as return_base::error_code.

Since

0.100.0

    {
        return error_code;
    }

Member Data Documentation

error_code

uint8_t Mastodon::return_base::error_code = 0

Error code.

Since

0.100.0

Examples

example01_get_public_timeline.cpp.

error_message

string Mastodon::return_base::error_message

The error message, or "".

Since

0.100.0

Examples

example01_get_public_timeline.cpp.

http_error_code

uint16_t Mastodon::return_base::http_error_code = 0

HTTP error code.

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