Mastodon::Easy::return_entity< T > Struct Template Reference

Return types for calls that return a single Easy::Entity. More...

#include <return_types_easy.hpp>

Inheritance diagram for Mastodon::Easy::return_entity< T >:

Public Member Functions
	return_entity (const uint8_t ec, const string &em, const uint16_t hec, const T &ent)
	Return type for easy Mastodon::Easy::API. More...
	return_entity (const error ec, const string &em, const uint16_t hec, const T &ent)
	Return type for easy Mastodon::Easy::API. More...
	operator const T () const
	Same as return_entity::entity. More...
	operator const string () const
	Mastodon::Easy::Entity as formatted string. 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
T	entity
	Mastodon::Easy::Entity. 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_entity< T > &ret)
	Mastodon::Easy::Entity as formatted string. More...

Detailed Description

template<typename T>
struct Mastodon::Easy::return_entity< T >

Return types for calls that return a single Easy::Entity.

Since

0.100.0

Constructor & Destructor Documentation

return_entity() [1/2]

template<typename T >

Easy::return_entity::return_entity	(	const uint8_t	ec,
		const string &	em,
		const uint16_t	hec,
		const T &	ent
	)

Return type for easy Mastodon::Easy::API.

Parameters

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

Since

0.100.0

    : entity(ent)
{
    error_code = ec;
    error_message = em;
    http_error_code = hec;
}

return_entity() [2/2]

template<typename T >

Easy::return_entity::return_entity	(	const error	ec,
		const string &	em,
		const uint16_t	hec,
		const T &	ent
	)

Return type for easy Mastodon::Easy::API.

Parameters

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

Since

0.110.0

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

Member Function Documentation

operator const string()

template<typename T>

Mastodon::Easy::return_entity< T >::operator const string

(

)

const

Mastodon::Easy::Entity as formatted string.

Since

0.100.0

operator const T()

template<typename T>

Mastodon::Easy::return_entity< T >::operator const T

(

)

const

Same as return_entity::entity.

Since

0.100.0

Friends And Related Function Documentation

operator<<

template<typename T>

std::ostream& operator<< ( std::ostream &  out, const return_entity< T > &  ret  )

friend

Mastodon::Easy::Entity as formatted string.

Since

0.100.0

        {
            // Could only get it to work by implementing it here.
            out << ret.entity.to_string();
            return out;
        }

Member Data Documentation

entity

template<typename T>

T Mastodon::Easy::return_entity< T >::entity

Mastodon::Easy::Entity.

Since

0.100.0

---

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

• src/easy/return_types_easy.hpp
• src/easy/return_types_easy.cpp