-
Notifications
You must be signed in to change notification settings - Fork 14
Expand file tree
/
Copy pathfields_base.hpp
More file actions
1397 lines (1066 loc) · 32.4 KB
/
fields_base.hpp
File metadata and controls
1397 lines (1066 loc) · 32.4 KB
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
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//
// Copyright (c) 2021 Vinnie Falco (vinnie.falco@gmail.com)
// Copyright (c) 2024 Christian Mazakas
// Copyright (c) 2025 Mohammad Nejati
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//
// Official repository: https://github.com/cppalliance/http_proto
//
#ifndef BOOST_HTTP_PROTO_FIELDS_BASE_HPP
#define BOOST_HTTP_PROTO_FIELDS_BASE_HPP
#include <boost/http_proto/detail/config.hpp>
#include <boost/http_proto/detail/except.hpp>
#include <boost/http_proto/detail/header.hpp>
#include <boost/core/detail/string_view.hpp>
#include <iosfwd>
namespace boost {
namespace http_proto {
/** Mixin for modifiable HTTP fields.
@par Iterators
Iterators obtained from @ref fields
containers are not invalidated when
the underlying container is modified.
@note HTTP field names are case-insensitive.
*/
class fields_base
{
detail::header h_;
std::size_t max_cap_ =
std::numeric_limits<std::size_t>::max();
bool view_ = false;
using entry =
detail::header::entry;
using offset_type =
detail::header::offset_type;
using table =
detail::header::table;
struct view_tag_t {};
static constexpr view_tag_t view_tag{};
class op_t;
class prefix_op_t
{
fields_base& self_;
offset_type new_prefix_;
char* buf_ = nullptr;
public:
prefix_op_t(
fields_base& self,
std::size_t new_prefix,
core::string_view* s0 = nullptr,
core::string_view* s1 = nullptr);
~prefix_op_t();
};
friend class fields;
friend class message_base;
friend class request;
friend class response;
friend class parser;
friend class request_parser;
friend class response_parser;
friend class serializer;
BOOST_HTTP_PROTO_DECL
explicit
fields_base(
detail::kind k) noexcept;
BOOST_HTTP_PROTO_DECL
fields_base(
detail::kind k,
core::string_view s);
BOOST_HTTP_PROTO_DECL
explicit
fields_base(
detail::header const& h);
BOOST_HTTP_PROTO_DECL
fields_base(
fields_base const&);
BOOST_HTTP_PROTO_DECL
fields_base(
view_tag_t,
detail::header const& h);
public:
//--------------------------------------------
//
// Types
//
//--------------------------------------------
/** A view to an HTTP field.
The view will be invalidated when the
underlying container is modified.
The caller is responsible for ensuring
that the lifetime of the container extends
until it is no longer referenced.
*/
struct reference
{
/** Field name constant.
Set to `boost::none` if the constant
does not exist in @ref field.
*/
boost::optional<field> const id;
/// A view to the field name.
core::string_view const name;
/// A view to the field value.
core::string_view const value;
reference const*
operator->() const noexcept
{
return this;
}
};
/// @copydoc reference
typedef reference const_reference;
/** A value type which represent an HTTP field.
This type allows for making a copy of
a field where ownership is retained
in the copy.
*/
struct value_type
{
/** Field name constant.
Set to `boost::none` if the
constant does not exist in @ref field.
*/
boost::optional<field> id;
/// Field name.
std::string name;
/// Field value.
std::string value;
/// Constructor.
BOOST_HTTP_PROTO_DECL
value_type(
reference const& other);
/** Conversion.
@see
@ref reference.
@return A view to the fields.
*/
operator reference() const noexcept;
};
/** A bidirectional iterator to HTTP fields.
*/
class iterator;
/// @copydoc iterator
using const_iterator = iterator;
/** A bidirectional reverse iterator to HTTP fields.
*/
class reverse_iterator;
/// @copydoc iterator
using const_reverse_iterator = reverse_iterator;
/** A forward range of matching fields.
Objects of this type are returned by
the function @ref find_all.
*/
class subrange;
//--------------------------------------------
//
// Special Members
//
//--------------------------------------------
/** Destructor.
*/
BOOST_HTTP_PROTO_DECL
~fields_base();
//--------------------------------------------
//
// Observers
//
//--------------------------------------------
/** Return the largest possible serialized message.
*/
static
constexpr
std::size_t
max_size() noexcept
{
// TODO: this doesn't take into account
// the start-line
return detail::header::max_offset;
}
/** Return an iterator to the beginning.
*/
iterator
begin() const noexcept;
/** Return an iterator to the end.
*/
iterator
end() const noexcept;
/** Return a reverse iterator to the beginning.
*/
reverse_iterator
rbegin() const noexcept;
/** Return a reverse iterator to the end.
*/
reverse_iterator
rend() const noexcept;
/** Return a string view representing the serialized data.
*/
core::string_view
buffer() const noexcept
{
return core::string_view(
h_.cbuf, h_.size);
}
/** Return the number of fields in the container.
*/
std::size_t
size() const noexcept
{
return h_.count;
}
/** Return the value of a field, or throws an exception.
If more than one field with the specified
name exists, the first field defined by
insertion order is returned.
@par Exception Safety
Strong guarantee.
@throw std::out_of_range
Field is not found.
@param id The field name constant.
*/
BOOST_HTTP_PROTO_DECL
core::string_view
at(field id) const;
/** Return the value of a field, or throws an exception.
If more than one field with the specified
name exists, the first field defined by
insertion order is returned.
If `name` refers to a known field, it is
faster to call @ref at with a field id
instead of a string.
@par Exception Safety
Strong guarantee.
@throw std::out_of_range
Field is not found.
@param name The field name.
*/
BOOST_HTTP_PROTO_DECL
core::string_view
at(core::string_view name) const;
/** Return true if a field exists.
*/
BOOST_HTTP_PROTO_DECL
bool
exists(field id) const noexcept;
/** Return true if a field exists.
If `name` refers to a known field,
it is faster to call @ref exists
with a field id instead of a string.
@param name The field name.
*/
BOOST_HTTP_PROTO_DECL
bool
exists(
core::string_view name) const noexcept;
/** Return the number of matching fields.
@param id The field name constant.
*/
BOOST_HTTP_PROTO_DECL
std::size_t
count(field id) const noexcept;
/** Return the number of matching fields.
If `name` refers to a known field,
it is faster to call @ref count
with a field id instead of a string.
@param name The field name.
*/
BOOST_HTTP_PROTO_DECL
std::size_t
count(
core::string_view name) const noexcept;
/** Return an iterator to the matching element if it exists.
@param id The field name constant.
*/
BOOST_HTTP_PROTO_DECL
iterator
find(field id) const noexcept;
/** Return an iterator to the matching element if it exists.
If `name` refers to a known field,
it is faster to call @ref find
with a field id instead of a string.
@param name The field name.
*/
BOOST_HTTP_PROTO_DECL
iterator
find(
core::string_view name) const noexcept;
/** Return an iterator to the matching element if it exists.
@param from The position to begin the
search from. This can be `end()`.
@param id The field name constant.
*/
BOOST_HTTP_PROTO_DECL
iterator
find(
iterator from,
field id) const noexcept;
/** Return an iterator to the matching element if it exists.
If `name` refers to a known field,
it is faster to call @ref find
with a field id instead of a string.
@param from The position to begin the
search from. This can be `end()`.
@param name The field name.
*/
BOOST_HTTP_PROTO_DECL
iterator
find(
iterator from,
core::string_view name) const noexcept;
/** Return an iterator to the matching element if it exists.
@param before One past the position
to begin the search from. This can
be `end()`.
@param id The field name constant.
*/
BOOST_HTTP_PROTO_DECL
iterator
find_last(
iterator before,
field id) const noexcept;
/** Return an iterator to the matching element if it exists.
If `name` refers to a known field,
it is faster to call @ref find_last
with a field id instead of a string.
@param before One past the position
to begin the search from. This can
be `end()`.
@param name The field name.
*/
BOOST_HTTP_PROTO_DECL
iterator
find_last(
iterator before,
core::string_view name) const noexcept;
/** Return the value of a field or a default if missing.
@param id The field name constant.
@param s The value to be returned if
field does not exist.
*/
BOOST_HTTP_PROTO_DECL
core::string_view
value_or(
field id,
core::string_view s) const noexcept;
/** Return the value of a field or a default if missing.
If `name` refers to a known field,
it is faster to call @ref value_or
with a field id instead of a string.
@param name The field name.
@param s The value to be returned if
field does not exist.
*/
BOOST_HTTP_PROTO_DECL
core::string_view
value_or(
core::string_view name,
core::string_view s) const noexcept;
/** Return a forward range containing values for all matching fields.
@param id The field name constant.
*/
BOOST_HTTP_PROTO_DECL
subrange
find_all(field id) const noexcept;
/** Return a forward range containing values for all matching fields.
If `name` refers to a known field,
it is faster to call @ref find_all
with a field id instead of a string.
@param name The field name.
*/
BOOST_HTTP_PROTO_DECL
subrange
find_all(
core::string_view name) const noexcept;
//--------------------------------------------
//
// Capacity
//
//--------------------------------------------
/** Return the maximum allowed capacity in bytes.
*/
std::size_t
max_capacity_in_bytes() noexcept
{
return max_cap_;
}
/** Return the total number of bytes allocated by the container.
*/
std::size_t
capacity_in_bytes() const noexcept
{
return h_.cap;
}
/** Clear contents while preserving the capacity.
In the case of response and request
containers the start-line also resets to
default.
@par Postconditions
@code
this->size() == 0
@endcode
@par Complexity
Constant.
*/
BOOST_HTTP_PROTO_DECL
void
clear() noexcept;
/** Adjust the capacity without changing the size.
This function adjusts the capacity
of the container in bytes, without
affecting the current contents. Has
no effect if `n <= this->capacity_in_bytes()`.
@par Postconditions
@code
this->capacity_in_bytes() >= n
@endcode
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
Exception thrown if max capacity exceeded.
@throw std::length_error
Max capacity would be exceeded.
@param n The capacity in bytes.
*/
BOOST_HTTP_PROTO_DECL
void
reserve_bytes(std::size_t n);
/** Set the maximum allowed capacity in bytes.
Prevents the container from growing beyond
`n` bytes. Exceeding this limit will throw
an exception.
@par Preconditions
@code
this->capacity_in_bytes() <= n
@endcode
@par Postconditions
@code
this->max_capacity_in_bytes() == n
@endcode
@par Exception Safety
Strong guarantee.
Exception thrown on invalid input.
@throw std::invalid_argument
`n < this->capacity_in_bytes()`
@param n The maximum allowed capacity in bytes.
*/
BOOST_HTTP_PROTO_DECL
void
set_max_capacity_in_bytes(std::size_t n);
/** Remove excess capacity.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
*/
BOOST_HTTP_PROTO_DECL
void
shrink_to_fit();
//--------------------------------------------
//
// Modifiers
//
//--------------------------------------------
/** Append a header.
This function appends a new header.
Existing headers with the same name are
not changed.
Any leading or trailing whitespace in the
value is ignored.
No iterators are invalidated.
@par Example
@code
request req;
req.append( field::user_agent, "Boost" );
@endcode
@par Complexity
Linear in `to_string( id ).size() + value.size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
Exception thrown on invalid input.
Exception thrown if max capacity exceeded.
@throw system_error
Input is invalid.
@throw std::length_error
Max capacity would be exceeded.
@param id The field name constant.
@param value The value which must be semantically
valid for the message.
*/
void
append(
field id,
core::string_view value)
{
system::error_code ec;
append(id, value, ec);
if(ec.failed())
detail::throw_system_error(ec);
}
/** Append a header.
This function appends a new header.
Existing headers with the same name are
not changed.
Any leading or trailing whitespace in the
value is ignored.
No iterators are invalidated.
@par Example
@code
request req;
req.append( field::user_agent, "Boost" );
@endcode
@par Complexity
Linear in `to_string( id ).size() + value.size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
Exception thrown if max capacity exceeded.
@throw std::length_error
Max capacity would be exceeded.
@param id The field name constant.
@param value The value which must be semantically
valid for the message.
@param ec Set to the error if input is invalid.
*/
void
append(
field id,
core::string_view value,
system::error_code& ec)
{
insert_impl(
id,
to_string(id),
value,
h_.count,
ec);
}
/** Append a header.
This function appends a new header.
Existing headers with the same name are
not changed.
Any leading or trailing whitespace in the
value is ignored.
No iterators are invalidated.
@par Example
@code
request req;
req.append( "User-Agent", "Boost" );
@endcode
@par Complexity
Linear in `name.size() + value.size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
Exception thrown on invalid input.
Exception thrown if max capacity exceeded.
@throw system_error
Input is invalid.
@throw std::length_error
Max capacity would be exceeded.
@param name The header name.
@param value The header value, which must
be semantically valid for the message.
*/
void
append(
core::string_view name,
core::string_view value)
{
system::error_code ec;
append(name, value, ec);
if(ec.failed())
detail::throw_system_error(ec);
}
/** Append a header.
This function appends a new header.
Existing headers with the same name are
not changed.
Any leading or trailing whitespace in the
value is ignored.
No iterators are invalidated.
@par Example
@code
request req;
req.append( "User-Agent", "Boost" );
@endcode
@par Complexity
Linear in `name.size() + value.size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
Exception thrown if max capacity exceeded.
@throw std::length_error
Max capacity would be exceeded.
@param name The header name.
@param value The value which must be semantically
valid for the message.
@param ec Set to the error if input is invalid.
*/
void
append(
core::string_view name,
core::string_view value,
system::error_code& ec)
{
insert_impl(
string_to_field(name),
name,
value,
h_.count,
ec);
}
/** Insert a header.
If a matching header with the same name
exists, it is not replaced. Instead, an
additional header with the same name is
inserted. Names are not case-sensitive.
Any leading or trailing whitespace in
the new value is ignored.
All iterators that are equal to `before`
or come after are invalidated.
@par Example
@code
request req;
req.insert( req.begin(), field::user_agent, "Boost" );
@endcode
@par Complexity
Linear in `to_string( id ).size() + value.size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
Exception thrown on invalid input.
Exception thrown if max capacity exceeded.
@throw system_error
Input is invalid.
@throw std::length_error
Max capacity would be exceeded.
@return An iterator to the newly inserted header.
@param before Position to insert before.
@param id The field name constant.
@param value The value which must be semantically
valid for the message.
*/
BOOST_HTTP_PROTO_DECL
iterator
insert(
iterator before,
field id,
core::string_view value);
/** Insert a header.
If a matching header with the same name
exists, it is not replaced. Instead, an
additional header with the same name is
inserted. Names are not case-sensitive.
Any leading or trailing whitespace in
the new value is ignored.
All iterators that are equal to `before`
or come after are invalidated.
@par Example
@code
request req;
req.insert( req.begin(), field::user_agent, "Boost" );
@endcode
@par Complexity
Linear in `to_string( id ).size() + value.size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
Exception thrown if max capacity exceeded.
@throw std::length_error
Max capacity would be exceeded.
@return An iterator to the newly inserted header.
@param before Position to insert before.
@param id The field name constant.
@param value The value which must be semantically
valid for the message.
@param ec Set to the error if input is invalid.
*/
BOOST_HTTP_PROTO_DECL
iterator
insert(
iterator before,
field id,
core::string_view value,
system::error_code& ec);
/** Insert a header.
If a matching header with the same name
exists, it is not replaced. Instead, an
additional header with the same name is
inserted. Names are not case-sensitive.
Any leading or trailing whitespace in
the new value is ignored.
All iterators that are equal to `before`
or come after are invalidated.
@par Example
@code
request req;
req.insert( req.begin(), "User-Agent", "Boost" );
@endcode
@par Complexity
Linear in `name.size() + value.size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
Exception thrown on invalid input.
Exception thrown if max capacity exceeded.
@throw system_error
Input is invalid.
@throw std::length_error
Max capacity would be exceeded.
@return An iterator to the newly inserted header.
@param before Position to insert before.
@param name The header name.
@param value The value which must be semantically
valid for the message.
*/
BOOST_HTTP_PROTO_DECL
iterator
insert(
iterator before,
core::string_view name,
core::string_view value);
/** Insert a header.
If a matching header with the same name
exists, it is not replaced. Instead, an
additional header with the same name is
inserted. Names are not case-sensitive.
Any leading or trailing whitespace in
the new value is ignored.
All iterators that are equal to `before`
or come after are invalidated.
@par Example
@code
request req;
req.insert( req.begin(), "User-Agent", "Boost" );
@endcode
@par Complexity
Linear in `name.size() + value.size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
Exception thrown if max capacity exceeded.
@throw std::length_error
Max capacity would be exceeded.
@return An iterator to the newly inserted header.
@param before Position to insert before.
@param name The header name.
@param value The value which must be semantically
valid for the message.
@param ec Set to the error if input is invalid.
*/
BOOST_HTTP_PROTO_DECL
iterator
insert(
iterator before,
core::string_view name,
core::string_view value,
system::error_code& ec);
//--------------------------------------------
/** Erase headers.
This function removes the header pointed
to by `it`.
All iterators that are equal to `it`
or come after are invalidated.
@par Complexity