From dfab999c9c218634102b7c9484abd058d8882023 Mon Sep 17 00:00:00 2001 From: tastytea Date: Thu, 16 Jan 2020 19:18:23 +0100 Subject: [PATCH] 2020-01-16 --- docs/connection_8hpp_source.html | 4 +- docs/curl__wrapper_8hpp_source.html | 6 +- docs/instance_8hpp_source.html | 2 +- docs/namespacemastodonpp.html | 2 +- docs/structmastodonpp_1_1answer__type.html | 22 ++-- docs/types_8hpp_source.html | 141 +++++++++++---------- 6 files changed, 89 insertions(+), 88 deletions(-) diff --git a/docs/connection_8hpp_source.html b/docs/connection_8hpp_source.html index cf82d28..a9c3723 100644 --- a/docs/connection_8hpp_source.html +++ b/docs/connection_8hpp_source.html @@ -199,7 +199,7 @@ $(function() {
mastodonpp::Connection::get
answer_type get(const endpoint_variant &endpoint, const parametermap &parameters)
Make a HTTP GET call with parameters.
Definition: connection.cpp:34
mastodonpp::event_type::type
string type
The type of the event.
Definition: connection.hpp:62
mastodonpp::Connection::post
answer_type post(const endpoint_variant &endpoint)
Make a HTTP POST call.
Definition: connection.hpp:164
-
mastodonpp::parametermap
map< string_view, variant< string_view, vector< string_view > >> parametermap
std::map of parameters for API calls.
Definition: types.hpp:64
+
mastodonpp::parametermap
map< string_view, variant< string_view, vector< string_view > >> parametermap
std::map of parameters for API calls.
Definition: types.hpp:66
mastodonpp::Connection::Connection
Connection(Instance &instance)
Construct a new Connection object.
Definition: connection.hpp:85
mastodonpp::Connection::put
answer_type put(const endpoint_variant &endpoint)
Make a HTTP PUT call.
Definition: connection.hpp:216
mastodonpp::Connection::get
answer_type get(const endpoint_variant &endpoint)
Make a HTTP GET call.
Definition: connection.hpp:127
@@ -214,7 +214,7 @@ $(function() {
mastodonpp::endpoint_variant
variant< API::endpoint_type, string_view > endpoint_variant
An endpoint. Either API::endpoint_type or std::string_view.
Definition: connection.hpp:43
mastodonpp::Connection::del
answer_type del(const endpoint_variant &endpoint, const parametermap &parameters)
Make a HTTP DELETE call with parameters.
Definition: connection.cpp:62
mastodonpp::event_type
A stream event.
Definition: connection.hpp:52
-
mastodonpp::answer_type
Return type for Requests.
Definition: types.hpp:82
+
mastodonpp::answer_type
Return type for Requests.
Definition: types.hpp:81
mastodonpp::Connection::patch
answer_type patch(const endpoint_variant &endpoint, const parametermap &parameters)
Make a HTTP PATCH call with parameters.
Definition: connection.cpp:48
mastodonpp::Instance
Holds the access data of an instance.
Definition: instance.hpp:45
mastodonpp::Connection::post
answer_type post(const endpoint_variant &endpoint, const parametermap &parameters)
Make a HTTP POST call with parameters.
Definition: connection.cpp:41
diff --git a/docs/curl__wrapper_8hpp_source.html b/docs/curl__wrapper_8hpp_source.html index 6fe05bc..a15ea94 100644 --- a/docs/curl__wrapper_8hpp_source.html +++ b/docs/curl__wrapper_8hpp_source.html @@ -239,14 +239,14 @@ $(function() {
mastodonpp::http_method
http_method
The HTTP method.
Definition: curl_wrapper.hpp:40
mastodonpp::CURLWrapper::CURLWrapper
CURLWrapper()
Initializes curl and sets up connection.
Definition: curl_wrapper.cpp:41
mastodonpp::CURLWrapper::get_curl_easy_handle
CURL * get_curl_easy_handle()
Returns pointer to the CURL easy handle.
Definition: curl_wrapper.hpp:105
-
mastodonpp::parametermap
map< string_view, variant< string_view, vector< string_view > >> parametermap
std::map of parameters for API calls.
Definition: types.hpp:64
+
mastodonpp::parametermap
map< string_view, variant< string_view, vector< string_view > >> parametermap
std::map of parameters for API calls.
Definition: types.hpp:66
mastodonpp::CURLWrapper::unescape_url
string unescape_url(const string_view url) const
URL decodes the given string .
Definition: curl_wrapper.hpp:145
mastodonpp
C++ wrapper for the Mastodon API.
Definition: api.cpp:19
mastodonpp::CURLWrapper::buffer_mutex
mutex buffer_mutex
Mutex for get_buffer a.k.a. _curl_buffer_body.
Definition: curl_wrapper.hpp:175
mastodonpp::CURLWrapper::get_buffer
string & get_buffer()
Returns a reference to the buffer libcurl writes into.
Definition: curl_wrapper.hpp:196
mastodonpp::CURLWrapper::set_proxy
void set_proxy(string_view proxy)
Set the proxy to use.
Definition: curl_wrapper.cpp:216
-
mastodonpp::answer_type
Return type for Requests.
Definition: types.hpp:82
-
mastodonpp::parameterpair
pair< string_view, variant< string_view, vector< string_view > >> parameterpair
A single parameter of a parametermap.
Definition: types.hpp:72
+
mastodonpp::answer_type
Return type for Requests.
Definition: types.hpp:81
+
mastodonpp::parameterpair
pair< string_view, variant< string_view, vector< string_view > >> parameterpair
A single parameter of a parametermap.
Definition: types.hpp:74
mastodonpp::CURLWrapper::set_cainfo
void set_cainfo(string_view path)
Set path to Certificate Authority (CA) bundle.
Definition: curl_wrapper.cpp:253
mastodonpp::CURLWrapper::operator=
CURLWrapper & operator=(const CURLWrapper &other)=delete
Copy assignment operator.
mastodonpp::CURLWrapper::set_useragent
void set_useragent(string_view useragent)
Sets the User-Agent.
Definition: curl_wrapper.cpp:263
diff --git a/docs/instance_8hpp_source.html b/docs/instance_8hpp_source.html index 3fded25..e7a919a 100644 --- a/docs/instance_8hpp_source.html +++ b/docs/instance_8hpp_source.html @@ -226,7 +226,7 @@ $(function() {
mastodonpp::CURLWrapper::set_proxy
void set_proxy(string_view proxy)
Set the proxy to use.
Definition: curl_wrapper.cpp:216
mastodonpp::Instance::get_post_formats
vector< string > get_post_formats() noexcept
Returns the allowed mime types for statuses.
mastodonpp::Instance::get_max_chars
uint64_t get_max_chars() noexcept
Returns the maximum number of characters per post.
-
mastodonpp::answer_type
Return type for Requests.
Definition: types.hpp:82
+
mastodonpp::answer_type
Return type for Requests.
Definition: types.hpp:81
mastodonpp::Instance::set_proxy
void set_proxy(const string_view proxy)
Set the proxy to use.
Definition: instance.hpp:147
mastodonpp::CURLWrapper::set_cainfo
void set_cainfo(string_view path)
Set path to Certificate Authority (CA) bundle.
Definition: curl_wrapper.cpp:253
mastodonpp::Instance
Holds the access data of an instance.
Definition: instance.hpp:45
diff --git a/docs/namespacemastodonpp.html b/docs/namespacemastodonpp.html index 990e5fb..15829ce 100644 --- a/docs/namespacemastodonpp.html +++ b/docs/namespacemastodonpp.html @@ -591,7 +591,7 @@ Functions -
mastodonpp::parametermap
map< string_view, variant< string_view, vector< string_view > >> parametermap
std::map of parameters for API calls.
Definition: types.hpp:64
+
mastodonpp::parametermap
map< string_view, variant< string_view, vector< string_view > >> parametermap
std::map of parameters for API calls.
Definition: types.hpp:66
mastodonpp::unescape_html
string unescape_html(string html)
Replaces HTML entities with UTF-8 characters.
Definition: helpers.cpp:40
diff --git a/docs/structmastodonpp_1_1answer__type.html b/docs/structmastodonpp_1_1answer__type.html index 97a5aa1..e3b1af5 100644 --- a/docs/structmastodonpp_1_1answer__type.html +++ b/docs/structmastodonpp_1_1answer__type.html @@ -79,7 +79,7 @@ $(function() {

Return type for Requests. More...

-

#include <mastodonpp/types.hpp>

+

#include <types.hpp>

@@ -198,9 +198,9 @@ Friends

Returns the parameters needed for the next entries.

Parses the Link header.

Since
0.3.0
-
165  {
-
166  return parse_pagination(true);
-
167  }
+
164  {
+
165  return parse_pagination(true);
+
166  }
@@ -292,9 +292,9 @@ Friends

Returns the parameters needed for the previous entries.

Parses the Link header.

Since
0.3.0
-
179  {
-
180  return parse_pagination(false);
-
181  }
+
178  {
+
179  return parse_pagination(false);
+
180  }
@@ -434,10 +434,10 @@ Friends
  • src/types.cpp
    • -
    mastodonpp::answer_type::headers
    string headers
    The headers of the response from the server.
    Definition: types.hpp:113
    -
    mastodonpp::answer_type::curl_error_code
    uint8_t curl_error_code
    The error code returned by libcurl.
    Definition: types.hpp:92
    -
    mastodonpp::answer_type::body
    string body
    The response from the server, usually JSON.
    Definition: types.hpp:120
    -
    mastodonpp::answer_type::http_status
    uint16_t http_status
    HTTP status code.
    Definition: types.hpp:106
    +
    mastodonpp::answer_type::headers
    string headers
    The headers of the response from the server.
    Definition: types.hpp:112
    +
    mastodonpp::answer_type::curl_error_code
    uint8_t curl_error_code
    The error code returned by libcurl.
    Definition: types.hpp:91
    +
    mastodonpp::answer_type::body
    string body
    The response from the server, usually JSON.
    Definition: types.hpp:119
    +
    mastodonpp::answer_type::http_status
    uint16_t http_status
    HTTP status code.
    Definition: types.hpp:105
    Generated by   diff --git a/docs/types_8hpp_source.html b/docs/types_8hpp_source.html index b8c64bc..498b6d8 100644 --- a/docs/types_8hpp_source.html +++ b/docs/types_8hpp_source.html @@ -100,80 +100,81 @@ $(function() {
    28 #include <variant>
    29 #include <vector>
    30 
    -
    31 namespace mastodonpp
    -
    32 {
    -
    33 
    -
    34 using std::uint8_t;
    -
    35 using std::uint16_t;
    -
    36 using std::map;
    -
    37 using std::ostream;
    -
    38 using std::string;
    -
    39 using std::string_view;
    -
    40 using std::pair;
    -
    41 using std::variant;
    -
    42 using std::vector;
    -
    43 
    -
    63 using parametermap =
    -
    64  map<string_view, variant<string_view, vector<string_view>>>;
    -
    65 
    -
    71 using parameterpair =
    -
    72  pair<string_view, variant<string_view, vector<string_view>>>;
    -
    73 
    -
    82 struct answer_type
    -
    83 {
    -
    92  uint8_t curl_error_code{0};
    -
    93 
    -
    99  string error_message;
    -
    100 
    -
    106  uint16_t http_status{0};
    -
    107 
    -
    113  string headers;
    -
    114 
    -
    120  string body;
    -
    121 
    -
    128  explicit operator bool() const;
    -
    129 
    -
    135  explicit operator string_view() const;
    -
    136 
    -
    142  friend ostream &operator <<(ostream &out, const answer_type &answer);
    -
    143 
    -
    153  [[nodiscard]]
    -
    154  string_view get_header(string_view field) const;
    -
    155 
    -
    163  [[nodiscard]]
    -
    164  inline parametermap next() const
    -
    165  {
    -
    166  return parse_pagination(true);
    -
    167  }
    -
    168 
    -
    177  [[nodiscard]]
    -
    178  inline parametermap prev() const
    -
    179  {
    -
    180  return parse_pagination(false);
    -
    181  }
    -
    182 
    -
    183 private:
    -
    192  [[nodiscard]]
    -
    193  parametermap parse_pagination(bool next) const;
    -
    194 };
    -
    195 
    -
    196 } // namespace mastodonpp
    -
    197 
    -
    198 #endif // MASTODONPP_TYPES_HPP
    +
    32 
    +
    33 namespace mastodonpp
    +
    34 {
    +
    35 
    +
    36 using std::uint8_t;
    +
    37 using std::uint16_t;
    +
    38 using std::map;
    +
    39 using std::ostream;
    +
    40 using std::string;
    +
    41 using std::string_view;
    +
    42 using std::pair;
    +
    43 using std::variant;
    +
    44 using std::vector;
    +
    45 
    +
    65 using parametermap =
    +
    66  map<string_view, variant<string_view, vector<string_view>>>;
    +
    67 
    +
    73 using parameterpair =
    +
    74  pair<string_view, variant<string_view, vector<string_view>>>;
    +
    75 
    +
    81 struct answer_type
    +
    82 {
    +
    91  uint8_t curl_error_code{0};
    +
    92 
    +
    98  string error_message;
    +
    99 
    +
    105  uint16_t http_status{0};
    +
    106 
    +
    112  string headers;
    +
    113 
    +
    119  string body;
    +
    120 
    +
    127  explicit operator bool() const;
    +
    128 
    +
    134  explicit operator string_view() const;
    +
    135 
    +
    141  friend ostream &operator <<(ostream &out, const answer_type &answer);
    +
    142 
    +
    152  [[nodiscard]]
    +
    153  string_view get_header(string_view field) const;
    +
    154 
    +
    162  [[nodiscard]]
    +
    163  inline parametermap next() const
    +
    164  {
    +
    165  return parse_pagination(true);
    +
    166  }
    +
    167 
    +
    176  [[nodiscard]]
    +
    177  inline parametermap prev() const
    +
    178  {
    +
    179  return parse_pagination(false);
    +
    180  }
    +
    181 
    +
    182 private:
    +
    191  [[nodiscard]]
    +
    192  parametermap parse_pagination(bool next) const;
    +
    193 };
    +
    194 
    +
    195 } // namespace mastodonpp
    +
    196 
    +
    197 #endif // MASTODONPP_TYPES_HPP
    mastodonpp::answer_type::operator<<
    friend ostream & operator<<(ostream &out, const answer_type &answer)
    Returns body as std::ostream.
    Definition: types.cpp:39
    -
    mastodonpp::answer_type::prev
    parametermap prev() const
    Returns the parameters needed for the previous entries.
    Definition: types.hpp:178
    -
    mastodonpp::answer_type::headers
    string headers
    The headers of the response from the server.
    Definition: types.hpp:113
    -
    mastodonpp::parametermap
    map< string_view, variant< string_view, vector< string_view > >> parametermap
    std::map of parameters for API calls.
    Definition: types.hpp:64
    -
    mastodonpp::answer_type::curl_error_code
    uint8_t curl_error_code
    The error code returned by libcurl.
    Definition: types.hpp:92
    +
    mastodonpp::answer_type::prev
    parametermap prev() const
    Returns the parameters needed for the previous entries.
    Definition: types.hpp:177
    +
    mastodonpp::answer_type::headers
    string headers
    The headers of the response from the server.
    Definition: types.hpp:112
    +
    mastodonpp::parametermap
    map< string_view, variant< string_view, vector< string_view > >> parametermap
    std::map of parameters for API calls.
    Definition: types.hpp:66
    +
    mastodonpp::answer_type::curl_error_code
    uint8_t curl_error_code
    The error code returned by libcurl.
    Definition: types.hpp:91
    mastodonpp
    C++ wrapper for the Mastodon API.
    Definition: api.cpp:19
    -
    mastodonpp::answer_type::body
    string body
    The response from the server, usually JSON.
    Definition: types.hpp:120
    -
    mastodonpp::answer_type::error_message
    string error_message
    The error message.
    Definition: types.hpp:99
    -
    mastodonpp::answer_type
    Return type for Requests.
    Definition: types.hpp:82
    +
    mastodonpp::answer_type::body
    string body
    The response from the server, usually JSON.
    Definition: types.hpp:119
    +
    mastodonpp::answer_type::error_message
    string error_message
    The error message.
    Definition: types.hpp:98
    +
    mastodonpp::answer_type
    Return type for Requests.
    Definition: types.hpp:81
    mastodonpp::answer_type::get_header
    string_view get_header(string_view field) const
    Returns the value of a header field.
    Definition: types.cpp:45
    -
    mastodonpp::parameterpair
    pair< string_view, variant< string_view, vector< string_view > >> parameterpair
    A single parameter of a parametermap.
    Definition: types.hpp:72
    -
    mastodonpp::answer_type::http_status
    uint16_t http_status
    HTTP status code.
    Definition: types.hpp:106
    -
    mastodonpp::answer_type::next
    parametermap next() const
    Returns the parameters needed for the next entries.
    Definition: types.hpp:164
    +
    mastodonpp::parameterpair
    pair< string_view, variant< string_view, vector< string_view > >> parameterpair
    A single parameter of a parametermap.
    Definition: types.hpp:74
    +
    mastodonpp::answer_type::http_status
    uint16_t http_status
    HTTP status code.
    Definition: types.hpp:105
    +
    mastodonpp::answer_type::next
    parametermap next() const
    Returns the parameters needed for the next entries.
    Definition: types.hpp:163
    Generated by  

    Public Member Functions