Skip to content

Commit a576bc8

Browse files
committed
Update reference page
1 parent e79539a commit a576bc8

1 file changed

Lines changed: 231 additions & 13 deletions

File tree

doc/modules/ROOT/pages/reference.adoc

Lines changed: 231 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
// Distributed under the Boost Software License, Version 1.0. (See accompanying
55
// file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
66
//
7-
// Official repository: https://github.com/boostorg/url
7+
// Official repository: https://github.com/boostorg/http
88
//
99

1010

@@ -17,14 +17,16 @@
1717

1818
| *Types (1/2)*
1919

20+
cpp:boost::http::application[application]
21+
22+
cpp:boost::http::datastore[datastore]
23+
2024
cpp:boost::http::fields[fields]
2125

2226
cpp:boost::http::fields_base[fields_base]
2327

2428
cpp:boost::http::file[file]
2529

26-
cpp:boost::http::file_source[file_source]
27-
2830
cpp:boost::http::header_limits[header_limits]
2931

3032
cpp:boost::http::message_base[message_base]
@@ -33,6 +35,8 @@ cpp:boost::http::metadata[metadata]
3335

3436
cpp:boost::http::parser[parser]
3537

38+
cpp:boost::http::polystore[polystore]
39+
3640
cpp:boost::http::request[request]
3741

3842
cpp:boost::http::request_base[request_base]
@@ -45,18 +49,30 @@ cpp:boost::http::response_base[response_base]
4549

4650
cpp:boost::http::response_parser[response_parser]
4751

52+
| **Types (2/2)**
53+
54+
cpp:boost::http::parser_config[parser_config]
55+
56+
cpp:boost::http::parser_config_impl[parser_config_impl]
57+
4858
cpp:boost::http::serializer[serializer]
4959

50-
| **Types (2/2)**
60+
cpp:boost::http::serializer_config[serializer_config]
5161

52-
cpp:boost::http::source[source]
62+
cpp:boost::http::serializer_config_impl[serializer_config_impl]
5363

5464
cpp:boost::http::static_request[static_request]
5565

5666
cpp:boost::http::static_response[static_response]
5767

5868
cpp:boost::http::string_body[string_body]
5969

70+
**Type Aliases**
71+
72+
cpp:boost::http::shared_parser_config[shared_parser_config]
73+
74+
cpp:boost::http::shared_serializer_config[shared_serializer_config]
75+
6076
**Functions**
6177

6278
cpp:boost::http::combine_field_values[combine_field_values]
@@ -67,6 +83,12 @@ cpp:boost::http::install_serializer_service[install_serializer_service]
6783

6884
cpp:boost::http::int_to_status[int_to_status]
6985

86+
cpp:boost::http::invoke[invoke]
87+
88+
cpp:boost::http::make_parser_config[make_parser_config]
89+
90+
cpp:boost::http::make_serializer_config[make_serializer_config]
91+
7092
cpp:boost::http::obsolete_reason[obsolete_reason]
7193

7294
cpp:boost::http::string_to_field[string_to_field]
@@ -77,8 +99,6 @@ cpp:boost::http::to_status_class[to_status_class]
7799

78100
cpp:boost::http::to_string[to_string]
79101

80-
// cpp:boost::http::operator<<[operator<<]
81-
82102
| **Constants**
83103

84104
cpp:boost::http::condition[condition]
@@ -101,11 +121,11 @@ cpp:boost::http::status_class[status_class]
101121

102122
cpp:boost::http::version[version]
103123

104-
**Type Traits**
124+
| **Grammar Rules**
105125

106-
cpp:boost::http::is_source[is_source]
126+
cpp:boost::http::list_rule[list_rule]
107127

108-
| **Grammar**
128+
cpp:boost::http::media_type_rule[media_type_rule]
109129

110130
cpp:boost::http::parameter_rule[parameter_rule]
111131

@@ -119,18 +139,216 @@ cpp:boost::http::upgrade_rule[upgrade_rule]
119139

120140
**Types**
121141

122-
cpp:boost::http::upgrade_protocol[upgrade_protocol]
142+
cpp:boost::http::media_type[media_type]
143+
144+
cpp:boost::http::mime_type[mime_type]
123145

124146
cpp:boost::http::parameter[parameter]
125147

126148
cpp:boost::http::quoted_token_view[quoted_token_view]
127149

150+
cpp:boost::http::upgrade_protocol[upgrade_protocol]
151+
152+
**Constants**
153+
154+
cpp:boost::http::tchars[tchars]
155+
156+
|===
157+
158+
[width=100%]
159+
|===
160+
2+| *Server*
161+
162+
| **Types (1/2)**
163+
164+
cpp:boost::http::basic_router[basic_router]
165+
166+
cpp:boost::http::byte_range[byte_range]
167+
168+
cpp:boost::http::cors[cors]
169+
170+
cpp:boost::http::cors_options[cors_options]
171+
172+
cpp:boost::http::dotfiles_policy[dotfiles_policy]
173+
174+
cpp:boost::http::etag_options[etag_options]
175+
176+
cpp:boost::http::flat_router[flat_router]
177+
178+
cpp:boost::http::range_result[range_result]
179+
180+
cpp:boost::http::range_result_type[range_result_type]
181+
182+
cpp:boost::http::route_params[route_params]
183+
184+
cpp:boost::http::route_params_base[route_params_base]
185+
186+
cpp:boost::http::route_result[route_result]
187+
188+
cpp:boost::http::route_task[route_task]
189+
190+
cpp:boost::http::route_what[route_what]
191+
192+
cpp:boost::http::router[router]
193+
194+
cpp:boost::http::router_options[router_options]
195+
196+
| **Types (2/2)**
197+
198+
cpp:boost::http::send_file_info[send_file_info]
199+
200+
cpp:boost::http::send_file_options[send_file_options]
201+
202+
cpp:boost::http::send_file_result[send_file_result]
203+
204+
cpp:boost::http::serve_static[serve_static]
205+
206+
cpp:boost::http::serve_static_options[serve_static_options]
207+
128208
**Functions**
129209

130-
cpp:boost::http::list_rule[list_rule]
210+
cpp:boost::http::encode_url[encode_url]
211+
212+
cpp:boost::http::escape_html[escape_html]
213+
214+
cpp:boost::http::etag[etag]
215+
216+
cpp:boost::http::format_http_date[format_http_date]
217+
218+
cpp:boost::http::is_fresh[is_fresh]
219+
220+
cpp:boost::http::parse_range[parse_range]
221+
222+
cpp:boost::http::route_error[route_error]
223+
224+
cpp:boost::http::send_file_init[send_file_init]
131225

132226
**Constants**
133227

134-
cpp:boost::http::tchars[tchars]
228+
cpp:boost::http::route_close[route_close]
229+
230+
cpp:boost::http::route_done[route_done]
231+
232+
cpp:boost::http::route_next[route_next]
233+
234+
cpp:boost::http::route_next_route[route_next_route]
235+
236+
**Namespace `mime_types`**
237+
238+
cpp:boost::http::mime_types::charset[charset]
239+
240+
cpp:boost::http::mime_types::content_type[content_type]
241+
242+
cpp:boost::http::mime_types::extension[extension]
243+
244+
cpp:boost::http::mime_types::lookup[lookup]
245+
246+
**Namespace `statuses`**
247+
248+
cpp:boost::http::statuses::is_empty[is_empty]
249+
250+
cpp:boost::http::statuses::is_redirect[is_redirect]
251+
252+
cpp:boost::http::statuses::is_retry[is_retry]
253+
254+
|===
255+
256+
[width=100%]
257+
|===
258+
3+| *ZLib* | *Brotli*
259+
260+
| **Types**
261+
262+
cpp:boost::http::zlib::deflate_service[deflate_service]
263+
264+
cpp:boost::http::zlib::inflate_service[inflate_service]
265+
266+
cpp:boost::http::zlib::stream[stream]
267+
268+
**Functions**
269+
270+
cpp:boost::http::zlib::install_deflate_service[install_deflate_service]
271+
272+
cpp:boost::http::zlib::install_inflate_service[install_inflate_service]
273+
274+
cpp:boost::http::zlib::install_zlib_service[install_zlib_service]
275+
276+
| **Constants**
277+
278+
cpp:boost::http::zlib::compression_level[compression_level]
279+
280+
cpp:boost::http::zlib::compression_method[compression_method]
281+
282+
cpp:boost::http::zlib::compression_strategy[compression_strategy]
283+
284+
cpp:boost::http::zlib::data_type[data_type]
285+
286+
cpp:boost::http::zlib::error[error]
287+
288+
cpp:boost::http::zlib::flush[flush]
289+
290+
| **Types**
291+
292+
cpp:boost::http::brotli::decode_service[decode_service]
293+
294+
cpp:boost::http::brotli::decoder_state[decoder_state]
295+
296+
cpp:boost::http::brotli::encode_service[encode_service]
297+
298+
cpp:boost::http::brotli::encoder_state[encoder_state]
299+
300+
**Functions**
301+
302+
cpp:boost::http::brotli::install_decode_service[install_decode_service]
303+
304+
cpp:boost::http::brotli::install_encode_service[install_encode_service]
305+
306+
cpp:boost::http::brotli::install_brotli_service[install_brotli_service]
307+
308+
| **Constants**
309+
310+
cpp:boost::http::brotli::constants[constants]
311+
312+
cpp:boost::http::brotli::decoder_param[decoder_param]
313+
314+
cpp:boost::http::brotli::decoder_result[decoder_result]
315+
316+
cpp:boost::http::brotli::encoder_mode[encoder_mode]
317+
318+
cpp:boost::http::brotli::encoder_operation[encoder_operation]
319+
320+
cpp:boost::http::brotli::encoder_parameter[encoder_parameter]
321+
322+
cpp:boost::http::brotli::error[error]
323+
324+
|===
325+
326+
[width=100%]
327+
|===
328+
2+| *bcrypt* | *JSON*
329+
330+
| **Types**
331+
332+
cpp:boost::http::bcrypt::result[result]
333+
334+
**Functions**
335+
336+
cpp:boost::http::bcrypt::compare[compare]
337+
338+
cpp:boost::http::bcrypt::gen_salt[gen_salt]
339+
340+
cpp:boost::http::bcrypt::get_rounds[get_rounds]
341+
342+
cpp:boost::http::bcrypt::hash[hash]
343+
344+
| **Constants**
345+
346+
cpp:boost::http::bcrypt::error[error]
347+
348+
cpp:boost::http::bcrypt::version[version]
349+
350+
| **Types**
351+
352+
cpp:boost::http::json_sink[json_sink]
135353

136354
|===

0 commit comments

Comments
 (0)