mastodonpp Namespace Reference

C++ wrapper for the Mastodon API. More...

Classes
struct	answer_type
	Return type for Requests. More...
class	API
	Holds API endpoints. More...
class	Connection
	Represents a connection to an instance. Used for requests. More...
class	CURLException
	Exception for libcurl errors. More...
class	CURLWrapper
	Handles the details of network connections. More...
class	Instance
	Holds the access data of an instance. More...

Typedefs
using	endpoint_variant = variant< API::endpoint_type, string_view >
	An endpoint. Either API::endpoint_type or std::string_view. More...
using	parametermap = map< string_view, variant< string_view, vector< string_view > >>
	std::map of parameters for API calls. More...

Enumerations
enum	http_method {   GET, POST, PATCH, PUT,   DELETE }
	The HTTP method. More...

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

Detailed Description

C++ wrapper for the Mastodon API.

Since

0.1.0

Typedef Documentation

endpoint_variant

using mastodonpp::endpoint_variant = typedef variant<API::endpoint_type,string_view>

An endpoint. Either API::endpoint_type or std::string_view.

Since

0.1.0

parametermap

using mastodonpp::parametermap = typedef map<string_view, variant<string_view, vector<string_view> >>

std::map of parameters for API calls.

Example:

parametermap parameters
    {
        {"id", "12"},
        {"poll[options]", vector<string_view>{"Yes", "No", "Maybe"}}
    };

Since

0.1.0

Enumeration Type Documentation

http_method

enum mastodonpp::http_method

strong

The HTTP method.

Since

0.1.0

{
    GET,
    POST,
    PATCH,
    PUT,
    DELETE
};

Function Documentation

operator<<()

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

Since

0.1.0

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