forked from userver-framework/userver-framework.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhttp__status_8hpp.html
478 lines (474 loc) · 22.4 KB
/
http__status_8hpp.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta property="og:image" content="../../logo_in_circle.png"/>
<meta property="og:image:alt" content="userver logo"/>
<link rel="icon" href="../../favicon.svg">
<title>userver: userver/server/http/http_status.hpp File Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<link rel="stylesheet" href="../../doxygen-like.css">
<script src="../../highlight.pack.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
<link href="../../customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0" style="width: 100%;">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><a id='logo-anchor' href="../../index.html"><img alt="Logo" src="../../logo.svg"/></a></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a class="titlelink" href="../../index.html">userver
</a>
</div>
<div id="projectbrief"><a class="titlelink" href="../../index.html">C++ Async Framework (beta)</a></div>
</td>
<td style="float: right; padding-right: 15px; padding-top: 15px;">
<a href="https://github.com/userver-framework/" rel="noopener" target="_blank" class="titlelink">
<img src="../../github_logo.svg" style="filter: invert(100%);" alt="Github"/>
</a>
<a href="https://t.me/userver_en" rel="noopener" id='telegram_channel' target="_blank" class="titlelink">
<img src="../../telegram_logo.svg" alt="Telegram"/>
</a>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="../../dir_26f8c63b8c67b2ed6c1b7078f08f1e18.html">userver</a></li><li class="navelem"><a class="el" href="../../dir_ee914885184833579e051451a9f6b65c.html">server</a></li><li class="navelem"><a class="el" href="../../dir_7c8aad318a3904861a0ee81bd37c7629.html">http</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#namespaces">Namespaces</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">http_status.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>HTTP status codes.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <string></code><br />
<code>#include <fmt/core.h></code><br />
<code>#include <userver/utils/fmt_compat.hpp></code><br />
</div><div class="textblock"><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="../../closed.png" alt="+"/> Include dependency graph for http_status.hpp:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="../../dd/d6e/http__status_8hpp__incl.png" border="0" usemap="#auserver_2server_2http_2http__status_8hpp" alt=""/></div>
<map name="auserver_2server_2http_2http__status_8hpp" id="auserver_2server_2http_2http__status_8hpp">
<area shape="rect" title="HTTP status codes." alt="" coords="28,5,175,45"/>
<area shape="rect" title=" " alt="" coords="5,93,64,119"/>
<area shape="rect" title=" " alt="" coords="129,167,218,192"/>
<area shape="rect" href="../../d3/d6c/fmt__compat_8hpp_source.html" title=" " alt="" coords="139,93,354,119"/>
</map>
</div>
</div><div class="textblock"><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="../../closed.png" alt="+"/> This graph shows which files directly or indirectly include this file:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="../../dd/d2e/http__status_8hpp__dep__incl.png" border="0" usemap="#auserver_2server_2http_2http__status_8hppdep" alt=""/></div>
<map name="auserver_2server_2http_2http__status_8hppdep" id="auserver_2server_2http_2http__status_8hppdep">
<area shape="rect" title="HTTP status codes." alt="" coords="700,5,847,45"/>
<area shape="rect" href="../../db/d08/legacy__json__error__builder_8hpp_source.html" title=" " alt="" coords="515,93,735,133"/>
<area shape="rect" href="../../da/dfa/http__error_8hpp.html" title="Get http status code mapped to generic handler error code." alt="" coords="515,284,661,324"/>
<area shape="rect" href="../../db/d6b/http__response_8hpp.html" title="HTTP Response data." alt="" coords="851,93,997,133"/>
<area shape="rect" href="../../d5/d4d/http__handler__flatbuf__base_8hpp.html" title="Convenient base for handlers that accept requests with body in Flatbuffer format and respond with bod..." alt="" coords="5,460,181,515"/>
<area shape="rect" href="../../d4/df6/http__handler__base_8hpp.html" title="Base class for all the Userver HTTP Handlers." alt="" coords="847,372,1023,412"/>
<area shape="rect" href="../../d2/d45/http__request_8hpp.html" title="HTTP Request data." alt="" coords="891,189,1037,229"/>
<area shape="rect" href="../../d8/d76/http__response__body__stream_8hpp_source.html" title=" " alt="" coords="1061,181,1219,236"/>
<area shape="rect" href="../../d6/d0d/dns__client__control_8hpp.html" title="Handlers that controls the DNS client." alt="" coords="205,467,381,507"/>
<area shape="rect" href="../../d6/dc0/dynamic__debug__log_8hpp.html" title="HTTP Handler to show/hide logs at the specific file:line." alt="" coords="405,467,589,507"/>
<area shape="rect" href="../../d1/d58/http__handler__json__base_8hpp.html" title="Convenient base for handlers that accept requests with body in JSON format and respond with body in J..." alt="" coords="613,467,821,507"/>
<area shape="rect" href="../../dd/db6/http__handler__static_8hpp.html" title="Handler that returns HTTP 200 if file exist and returns file data with mapped content/type." alt="" coords="845,467,1024,507"/>
<area shape="rect" href="../../d5/d86/jemalloc_8hpp.html" title="Handler that controlls the jemalloc allocator." alt="" coords="1048,467,1224,507"/>
<area shape="rect" href="../../d0/d01/log__level_8hpp.html" title="Handler that controlls logging levels of all the loggers." alt="" coords="1248,467,1424,507"/>
<area shape="rect" href="../../d8/d39/ping_8hpp.html" title="Handler that returns HTTP 200 if the service is OK and able to process requests." alt="" coords="1448,467,1624,507"/>
<area shape="rect" href="../../de/d18/server__monitor_8hpp.html" title="Handler that returns statistics data." alt="" coords="1648,467,1824,507"/>
<area shape="rect" href="../../d8/d82/core_2include_2userver_2server_2server_8hpp_source.html" title=" " alt="" coords="1849,475,2037,500"/>
<area shape="rect" href="../../d7/d79/inspect__requests_8hpp.html" title="Handler that returns information about all in-flight requests." alt="" coords="529,563,705,603"/>
<area shape="rect" href="../../d6/d43/tests__control_8hpp.html" title="Handler that allows to control the behavior of server from tests." alt="" coords="729,563,905,603"/>
<area shape="rect" href="../../d3/ddd/core_2include_2userver_2server_2component_8hpp.html" title="Component that listens for incomming requests, manages incomming connections and passes the requests ..." alt="" coords="1832,570,2053,595"/>
<area shape="rect" href="../../da/dff/auth__checker__base_8hpp_source.html" title=" " alt="" coords="972,284,1183,324"/>
<area shape="rect" href="../../db/ddd/auth__checker__factory_8hpp.html" title="Authorization factory registration and base classes." alt="" coords="1047,372,1271,412"/>
</map>
</div>
</div>
<p><a href="../../d0/d6f/http__status_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d66/structfmt_1_1formatter_3_1_1server_1_1http_1_1HttpStatus_01_4.html">fmt::formatter<::server::http::HttpStatus ></a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:df/df5/namespaceserver_1_1http"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/df5/namespaceserver_1_1http.html">server::http</a></td></tr>
<tr class="memdesc:df/df5/namespaceserver_1_1http"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="../../d0/d68/classserver_1_1Server.html">Server</a> parts of the HTTP protocol implementation. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a2bfd82052ce780ec23a3a0d95e5df2c9"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/df5/namespaceserver_1_1http.html#a2bfd82052ce780ec23a3a0d95e5df2c9">server::http::HttpStatus</a> { <br />
  <b>kContinue</b> = 100
, <br />
  <b>kSwitchingProtocols</b> = 101
, <br />
  <b>kProcessing</b> = 102
, <br />
  <b>kOk</b> = 200
, <br />
  <b>kCreated</b> = 201
, <br />
  <b>kAccepted</b> = 202
, <br />
  <b>kNonAuthoritativeInformation</b> = 203
, <br />
  <b>kNoContent</b> = 204
, <br />
  <b>kResetContent</b> = 205
, <br />
  <b>kPartialContent</b> = 206
, <br />
  <b>kMultiStatus</b> = 207
, <br />
  <b>kAlreadyReported</b> = 208
, <br />
  <b>kImUsed</b> = 226
, <br />
  <b>kMultipleChoices</b> = 300
, <br />
  <b>kMovedPermanently</b> = 301
, <br />
  <b>kFound</b> = 302
, <br />
  <b>kSeeOther</b> = 303
, <br />
  <b>kNotModified</b> = 304
, <br />
  <b>kUseProxy</b> = 305
, <br />
  <b>kTemporaryRedirect</b> = 307
, <br />
  <b>kPermanentRedirect</b> = 308
, <br />
  <b>kBadRequest</b> = 400
, <br />
  <b>kUnauthorized</b> = 401
, <br />
  <b>kPaymentRequired</b> = 402
, <br />
  <b>kForbidden</b> = 403
, <br />
  <b>kNotFound</b> = 404
, <br />
  <b>kMethodNotAllowed</b> = 405
, <br />
  <b>kNotAcceptable</b> = 406
, <br />
  <b>kProxyAuthenticationRequired</b> = 407
, <br />
  <b>kRequestTimeout</b> = 408
, <br />
  <b>kConflict</b> = 409
, <br />
  <b>kGone</b> = 410
, <br />
  <b>kLengthRequired</b> = 411
, <br />
  <b>kPreconditionFailed</b> = 412
, <br />
  <b>kPayloadTooLarge</b> = 413
, <br />
  <b>kUriTooLong</b> = 414
, <br />
  <b>kUnsupportedMediaType</b> = 415
, <br />
  <b>kRangeNotSatisfiable</b> = 416
, <br />
  <b>kExpectationFailed</b> = 417
, <br />
  <b>kMisdirectedRequest</b> = 421
, <br />
  <b>kUnprocessableEntity</b> = 422
, <br />
  <b>kLocked</b> = 423
, <br />
  <b>kFailedDependency</b> = 424
, <br />
  <b>kUpgradeRequired</b> = 426
, <br />
  <b>kPreconditionRequired</b> = 428
, <br />
  <b>kTooManyRequests</b> = 429
, <br />
  <b>kRequestHeaderFieldsTooLarge</b> = 431
, <br />
  <b>kUnavailableForLegalReasons</b> = 451
, <br />
  <b>kClientClosedRequest</b> = 499
, <br />
  <b>kInternalServerError</b> = 500
, <br />
  <b>kNotImplemented</b> = 501
, <br />
  <b>kBadGateway</b> = 502
, <br />
  <b>kServiceUnavailable</b> = 503
, <br />
  <b>kGatewayTimeout</b> = 504
, <br />
  <b>kHttpVersionNotSupported</b> = 505
, <br />
  <b>kVariantAlsoNegotiates</b> = 506
, <br />
  <b>kInsufficientStorage</b> = 507
, <br />
  <b>kLoopDetected</b> = 508
, <br />
  <b>kNotExtended</b> = 510
, <br />
  <b>kNetworkAuthenticationRequired</b> = 511
<br />
}</td></tr>
<tr class="memdesc:a2bfd82052ce780ec23a3a0d95e5df2c9"><td class="mdescLeft"> </td><td class="mdescRight">HTTP status codes. <a href="../../df/df5/namespaceserver_1_1http.html#a2bfd82052ce780ec23a3a0d95e5df2c9">More...</a><br /></td></tr>
<tr class="separator:a2bfd82052ce780ec23a3a0d95e5df2c9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a1370b4763f1400bebcf83bad0b63b619"><td class="memItemLeft" align="right" valign="top"><a id="a1370b4763f1400bebcf83bad0b63b619" name="a1370b4763f1400bebcf83bad0b63b619"></a>
std::string </td><td class="memItemRight" valign="bottom"><b>server::http::HttpStatusString</b> (HttpStatus status)</td></tr>
<tr class="separator:a1370b4763f1400bebcf83bad0b63b619"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa21f3a27813c8639bd1c017f6278100f"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/df5/namespaceserver_1_1http.html#aa21f3a27813c8639bd1c017f6278100f">server::http::ToString</a> (HttpStatus status)</td></tr>
<tr class="separator:aa21f3a27813c8639bd1c017f6278100f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >HTTP status codes. </p>
<p class="definition">Definition in file <a class="el" href="../../d0/d6f/http__status_8hpp_source.html">http_status.hpp</a>.</p>
</div></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<hr class="footer"/>
<address class="footer"><small>
Generated on Fri Sep 23 2022 12:31:42 for userver by <a href="http://www.doxygen.org/index.html">Doxygen</a> 1.9.5
</small></address>
<script type="text/javascript">
const LOWER_CASE_TRANSLITTERATION_MAPPING = {
"а":"a", "б":"b", "в":"v", "г":"g", "д":"d", "е":"e", "ё":"jo", "ж":"zh",
"з":"z", "и":"i", "й":"jj", "к":"k", "л":"l", "м":"m", "н":"n", "о":"o",
"п":"p", "р":"r", "с":"s", "т":"t", "у":"u", "ф":"f", "х":"x", "ц":"c",
"ч":"ch", "ш":"sh", "щ":"shh", "ъ":"\'", "ы":"y", "ь":"\'", "э":"je",
"ю":"ju", "я":"ja"
};
const DOXYGEN_DIAMOND_STRING = '◆\u00A0' // ◆
function make_id(raw_id) {
return raw_id.toLowerCase().split('').map(function (char) {
return LOWER_CASE_TRANSLITTERATION_MAPPING[char] || char;
}).join('').replace(/\W/g, '');
}
const html_escape = function () {
const p = document.createElement('p');
return function (text) {
p.textContent = text;
return p.innerHTML;
};
}();
function draw_toc() {
let headers = $(':header');
if (headers.length === 0) {
return;
}
let sidenav_content = '<div id="mySidenav" class="sidenav">';
sidenav_content += '<h2>Table of contents</h2>';
headers.each(function() {
let index = parseInt(this.nodeName.substring(1)) - 1;
const header = $(this);
let id = header.attr('id');
if (!id) {
id = make_id(header.text())
header.attr('id', id);
}
let header_text = header.text()
if (header_text.startsWith(DOXYGEN_DIAMOND_STRING)) {
++index;
header_text = header_text.substring(DOXYGEN_DIAMOND_STRING.length);
}
sidenav_content += ''
+ '<a href="#' + id + '" style="padding-left: ' + index * 15 + 'px">'
+ '• ' + html_escape(header_text)
+ '</a>'
;
header.append(' <a class="hoverlink" href="#' + id + '">🔗</a>')
});
sidenav_content += '</div>';
$(sidenav_content).insertAfter('.header');
}
function highlight_code() {
if (window.location.href.indexOf("pp_source") !== -1
|| window.location.href.indexOf("cpp-example") !== -1) {
// Header listing is already nicely highlighted by Doxygen
return;
}
hljs.configure({
tabReplace: ' ' // 4 spaces
});
hljs.registerAliases('sh', {languageName: 'shell'});
hljs.registerAliases('bash', {languageName: 'shell'});
hljs.registerAliases('yml', {languageName: 'yaml'});
hljs.registerAliases('plain', {languageName: 'plaintext'});
hljs.registerAliases('tskv', {languageName: 'plaintext'});
$(".fragment").each(function() {
const node = $(this);
let data = '';
let language = '';
let requires_higlighting = true;
node.children('div.line').each(function(i) {
line = $(this).text();
// Doxygen 1.8.11 workaround to remove line numbers.
// No line numbers added in Doxygen 1.8.13
line = line.replace(/^ *\d+\xA0/, '');
if (i === 0) {
line = line.trimLeft().replace(/^# /, '');
if (line === 'autodetect') {
return true;
} else if (hljs.getLanguage(line)) {
language = line;
return true;
} else {
requires_higlighting = false;
return false;
}
}
data += line + '\n';
});
if (requires_higlighting === false) {
return;
}
if (language !== '') {
data = hljs.highlight(language, data).value;
} else {
data = hljs.highlightAuto(data).value;
}
node.replaceWith('<div class="fragment"><pre>' + data + '</pre></div>');
});
}
function setup_if_landing() {
if (document.getElementById('landing_logo_id') === null) {
return false;
}
$(function() {
const main_nav = $('#main-nav');
main_nav.addClass('main-nav-landing');
main_nav.append('<hr>');
});
return true;
}
function sticky_menu() {
const main_nav = $('#main-nav');
const menu_y_position = 94;
const search_results_window = $('#MSearchResultsWindow');
const search_select_window = $('#MSearchSelectWindow');
var menu_is_sticky = false;
const stick = function () {
if ($(this).scrollTop() > menu_y_position) {
if (menu_is_sticky) return;
search_results_window.addClass('stickySearchResults');
search_select_window.addClass('stickySearchResults');
main_nav.addClass('stickyHeader');
// Prevent page quick movement as the menu sticks to the top
document.body.style.paddingTop = '36px';
menu_is_sticky = true;
} else {
if (!menu_is_sticky) return;
search_results_window.removeClass('stickySearchResults');
search_select_window.removeClass('stickySearchResults');
// 'top' property of the results window is computed by Doxygen JS
// and it may give bad results if the computation is invoked at the
// middle of the page.
//
// Hiding the window. Doxygen will recompute and show it on new
// user input.
search_results_window.hide();
main_nav.removeClass('stickyHeader');
document.body.style.paddingTop = '0px';
menu_is_sticky = false;
}
};
stick(); // on page refresh draw the menu on the right position
$(window).on("scroll", stick);
}
function telegram_channel_language() {
if (/^ru/.test(navigator.language)) {
const channel = $('#telegram_channel');
if (channel) {
channel.attr('href', 'https://t.me/userver_ru');
}
}
}
// We do not use $(function() { ... }); because
// * all the elements (except menue parts) are already parsed up above
// * skipping it speedups page load
// * with it Firefox does not scroll to a JS generated anchor links
telegram_channel_language();
if (!setup_if_landing()) {
draw_toc();
highlight_code();
sticky_menu();
}
</script>
</body>
</html>