-
Notifications
You must be signed in to change notification settings - Fork 50
/
url_base.hpp
3046 lines (2395 loc) · 84.8 KB
/
url_base.hpp
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) 2019 Vinnie Falco (vinnie.falco@gmail.com)
// Copyright (c) 2022 Alan de Freitas (alandefreitas@gmail.com)
//
// 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/boostorg/url
//
#ifndef BOOST_URL_URL_BASE_HPP
#define BOOST_URL_URL_BASE_HPP
#include <boost/url/detail/config.hpp>
#include <boost/url/ipv4_address.hpp>
#include <boost/url/ipv6_address.hpp>
#include <boost/url/params_encoded_ref.hpp>
#include <boost/url/params_ref.hpp>
#include <boost/url/pct_string_view.hpp>
#include <boost/url/scheme.hpp>
#include <boost/url/segments_encoded_ref.hpp>
#include <boost/url/segments_ref.hpp>
#include <boost/url/url_view_base.hpp>
#include <cstdint>
#include <initializer_list>
#include <memory>
#include <string>
#include <utility>
namespace boost {
namespace urls {
#ifndef BOOST_URL_DOCS
namespace detail {
struct any_params_iter;
struct any_segments_iter;
struct params_iter_impl;
struct segments_iter_impl;
struct pattern;
}
#endif
/** Common functionality for containers
This base class is used by the library
to provide common member functions for
containers. This cannot be instantiated
directly; Instead, use one of the
containers or functions:
@par Containers
@li @ref url
@li @ref url_view
@li @ref static_url
@par Functions
@li @ref parse_absolute_uri
@li @ref parse_origin_form
@li @ref parse_relative_ref
@li @ref parse_uri
@li @ref parse_uri_reference
*/
class BOOST_URL_DECL
url_base
: public url_view_base
{
char* s_ = nullptr;
std::size_t cap_ = 0;
friend class url;
friend class static_url_base;
friend class params_ref;
friend class segments_ref;
friend class segments_encoded_ref;
friend class params_encoded_ref;
#ifndef BOOST_URL_DOCS
friend struct detail::pattern;
#endif
struct op_t
{
~op_t();
op_t(url_base&,
core::string_view* = nullptr,
core::string_view* = nullptr) noexcept;
void move(char*, char const*,
std::size_t) noexcept;
url_base& u;
core::string_view* s0 = nullptr;
core::string_view* s1 = nullptr;
char* old = nullptr;
};
virtual ~url_base() noexcept = default;
url_base() noexcept = default;
url_base(detail::url_impl const&) noexcept;
explicit url_base(core::string_view);
void reserve_impl(std::size_t n);
void copy(url_view_base const&);
virtual void clear_impl() noexcept = 0;
virtual void reserve_impl(
std::size_t, op_t&) = 0;
virtual void cleanup(op_t&) = 0;
public:
//--------------------------------------------
//
// Observers
//
//--------------------------------------------
/** Return the url as a null-terminated string
This function returns a pointer to a null
terminated string representing the url,
which may contain percent escapes.
@par Example
@code
assert( std::strlen( url( "http://www.example.com" ).c_str() ) == 22 );
@endcode
@par Complexity
Constant.
@par Exception Safety
Throws nothing.
*/
char const*
c_str() const noexcept
{
return pi_->cs_;
}
/** Return the number of characters that can be stored without reallocating
This does not include the null terminator,
which is always present.
@par Complexity
Constant.
@par Exception Safety
Throws nothing.
*/
std::size_t
capacity() const noexcept
{
return cap_;
}
/** Clear the contents while preserving the capacity
@par Postconditions
@code
this->empty() == true
@endcode
@par Complexity
Constant.
@par Exception Safety
No-throw guarantee.
*/
void
clear() noexcept
{
this->clear_impl();
}
/** Adjust the capacity without changing the size
This function adjusts the capacity
of the container in characters, without
affecting the current contents. Has
no effect if `n <= this->capacity()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
@throw bad_alloc Allocation failure
@param n The capacity in characters,
excluding any null terminator.
*/
void
reserve(std::size_t n)
{
reserve_impl(n);
}
//--------------------------------------------
//
// Fluent API
//
//--------------------------------------------
//
// Scheme
//
//--------------------------------------------
/** Set the scheme
The scheme is set to the specified
string, which must contain a valid
scheme without any trailing colon
(':').
Note that schemes are case-insensitive,
and the canonical form is lowercased.
@par Example
@code
assert( url( "http://www.example.com" ).set_scheme( "https" ).scheme_id() == scheme::https );
@endcode
@par Complexity
Linear in `this->size() + s.size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
Exceptions thrown on invalid input.
@throw system_error
`s` contains an invalid scheme.
@param s The scheme to set.
@par BNF
@code
scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )
@endcode
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.1">
3.1. Scheme (rfc3986)</a>
@see
@ref remove_scheme.
*/
url_base&
set_scheme(core::string_view s);
#ifndef BOOST_URL_DOCS
/** Set the scheme
This function sets the scheme to the specified
known @ref urls::scheme id, which may not be
@ref scheme::unknown or else an exception is
thrown. If the id is @ref scheme::none, this
function behaves as if @ref remove_scheme
were called.
@par Example
@code
assert( url( "http://example.com/echo.cgi" ).set_scheme_id( scheme::wss ).buffer() == "wss://example.com/echo.cgi" );
@endcode
@par Complexity
Linear in `this->size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
Exceptions thrown on invalid input.
@throw system_error
The scheme is invalid.
@param id The scheme to set.
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.1">
3.1. Scheme (rfc3986)</a>
*/
url_base&
set_scheme_id(urls::scheme id);
#else
/** Set the scheme
This function sets the scheme to the specified
known @ref urls::scheme id, which may not be
@ref scheme::unknown or else an exception is
thrown. If the id is @ref scheme::none, this
function behaves as if @ref remove_scheme
were called.
@par Example
@code
assert( url( "http://example.com/echo.cgi" ).set_scheme_id( scheme::wss ).buffer() == "wss://example.com/echo.cgi" );
@endcode
@par Complexity
Linear in `this->size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
Exceptions thrown on invalid input.
@throw system_error
The scheme is invalid.
@param id The scheme to set.
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.1">
3.1. Scheme (rfc3986)</a>
*/
url_base&
set_scheme_id(scheme id);
#endif
/** Remove the scheme
This function removes the scheme if it
is present.
@par Example
@code
assert( url("http://www.example.com/index.htm" ).remove_scheme().buffer() == "//www.example.com/index.htm" );
@endcode
@par Postconditions
@code
this->has_scheme() == false && this->scheme_id() == scheme::none
@endcode
@par Complexity
Linear in `this->size()`.
@par Exception Safety
Throws nothing.
@par BNF
@code
URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
@endcode
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.1">
3.1. Scheme (rfc3986)</a>
@see
@ref set_scheme.
*/
url_base&
remove_scheme();
//--------------------------------------------
//
// Authority
//
//--------------------------------------------
/** Set the authority
This function sets the authority
to the specified string.
The string may contain percent-escapes.
@par Example
@code
assert( url().set_encoded_authority( "My%20Computer" ).has_authority() );
@endcode
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
Exceptions thrown on invalid input.
@throw system_eror
The string contains an invalid percent-encoding.
@param s The authority string to set.
@par BNF
@code
authority = [ userinfo "@" ] host [ ":" port ]
userinfo = *( unreserved / pct-encoded / sub-delims / ":" )
host = IP-literal / IPv4address / reg-name
port = *DIGIT
@endcode
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.2">
3.2. Authority (rfc3986)</a>
@see
@ref remove_authority.
*/
url_base&
set_encoded_authority(
pct_string_view s);
/** Remove the authority
This function removes the authority,
which includes the userinfo, host, and
a port if present.
@par Example
@code
assert( url( "http://example.com/echo.cgi" ).remove_authority().buffer() == "http:/echo.cgi" );
@endcode
@par Postconditions
@code
this->has_authority() == false && this->has_userinfo() == false && this->has_port() == false
@endcode
@par Complexity
Linear in `this->size()`.
@par Exception Safety
Throws nothing.
@par BNF
@code
authority = [ userinfo "@" ] host [ ":" port ]
userinfo = *( unreserved / pct-encoded / sub-delims / ":" )
host = IP-literal / IPv4address / reg-name
port = *DIGIT
@endcode
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.2">
3.2. Authority (rfc3986)</a>
@see
@ref set_encoded_authority.
*/
url_base&
remove_authority();
//--------------------------------------------
//
// Userinfo
//
//--------------------------------------------
/** Set the userinfo
The userinfo is set to the given string,
which may contain percent-escapes.
Any special or reserved characters in the
string are automatically percent-encoded.
The effects on the user and password
depend on the presence of a colon (':')
in the string:
@li If an unescaped colon exists, the
characters up to the colon become
the user and the rest of the characters
after the colon become the password.
In this case @ref has_password returns
true. Otherwise,
@li If there is no colon, the user is
set to the string. The function
@ref has_password returns false.
@note
The interpretation of the userinfo as
individual user and password components
is scheme-dependent. Transmitting
passwords in URLs is deprecated.
@par Example
@code
assert( url( "http://example.com" ).set_userinfo( "user:pass" ).encoded_user() == "user" );
@endcode
@par Complexity
Linear in `this->size() + s.size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
@param s The string to set.
@par BNF
@code
userinfo = [ [ user ] [ ':' password ] ]
user = *( unreserved / pct-encoded / sub-delims )
password = *( unreserved / pct-encoded / sub-delims / ":" )
@endcode
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1">
3.2.1. User Information (rfc3986)</a>
@see
@ref remove_userinfo,
@ref set_encoded_userinfo.
*/
url_base&
set_userinfo(
core::string_view s);
/** Set the userinfo.
The userinfo is set to the given string,
which may contain percent-escapes.
Escapes in the string are preserved,
and reserved characters in the string
are percent-escaped in the result.
The effects on the user and password
depend on the presence of a colon (':')
in the string:
@li If an unescaped colon exists, the
characters up to the colon become
the user and the rest of the characters
after the colon become the password.
In this case @ref has_password returns
true. Otherwise,
@li If there is no colon, the user is
set to the string. The function
@ref has_password returns false.
@note
The interpretation of the userinfo as
individual user and password components
is scheme-dependent. Transmitting
passwords in URLs is deprecated.
@par Example
@code
assert( url( "http://example.com" ).set_encoded_userinfo( "john%20doe" ).user() == "john doe" );
@endcode
@par Complexity
Linear in `this->size() + s.size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
Exceptions thrown on invalid input.
@throw system_error
`s` contains an invalid percent-encoding.
@param s The string to set.
@par BNF
@code
userinfo = [ [ user ] [ ':' password ] ]
user = *( unreserved / pct-encoded / sub-delims )
password = *( unreserved / pct-encoded / sub-delims / ":" )
@endcode
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1">
3.2.1. User Information (rfc3986)</a>
@see
@ref remove_userinfo,
@ref set_userinfo.
*/
url_base&
set_encoded_userinfo(
pct_string_view s);
/** Remove the userinfo
This function removes the userinfo if
present, without removing any authority.
@par Example
@code
assert( url( "http://user@example.com" ).remove_userinfo().has_userinfo() == false );
@endcode
@par Postconditions
@code
this->has_userinfo() == false && this->encoded_userinfo().empty == true
@endcode
@par Complexity
Linear in `this->size()`.
@par Exception Safety
Throws nothing.
@par BNF
@code
userinfo = [ [ user ] [ ':' password ] ]
user = *( unreserved / pct-encoded / sub-delims )
password = *( unreserved / pct-encoded / sub-delims / ":" )
@endcode
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1">
3.2.1. User Information (rfc3986)</a>
@see
@ref set_encoded_userinfo,
@ref set_userinfo.
*/
url_base&
remove_userinfo() noexcept;
//--------------------------------------------
/** Set the user
This function sets the user part of the
userinfo to the string.
Any special or reserved characters in the
string are automatically percent-encoded.
@par Example
@code
assert( url().set_user("john doe").encoded_userinfo() == "john%20doe" );
@endcode
@par Postconditions
@code
this->has_authority() == true && this->has_userinfo() == true
@endcode
@par Complexity
Linear in `this->size() + s.size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
@param s The string to set.
@par BNF
@code
userinfo = [ [ user ] [ ':' password ] ]
user = *( unreserved / pct-encoded / sub-delims )
password = *( unreserved / pct-encoded / sub-delims / ":" )
@endcode
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1">
3.2.1. User Information (rfc3986)</a>
@see
@ref remove_password,
@ref set_encoded_password,
@ref set_encoded_user,
@ref set_password.
*/
url_base&
set_user(
core::string_view s);
/** Set the user
This function sets the user part of the
userinfo the the string, which may
contain percent-escapes.
Escapes in the string are preserved,
and reserved characters in the string
are percent-escaped in the result.
@par Example
@code
assert( url().set_encoded_user("john%20doe").userinfo() == "john doe" );
@endcode
@par Postconditions
@code
this->has_authority() == true && this->has_userinfo() == true
@endcode
@par Complexity
Linear in `this->size() + s.size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
@throw system_error
`s` contains an invalid percent-encoding.
@param s The string to set.
@par BNF
@code
userinfo = [ [ user ] [ ':' password ] ]
user = *( unreserved / pct-encoded / sub-delims )
password = *( unreserved / pct-encoded / sub-delims / ":" )
@endcode
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1">
3.2.1. User Information (rfc3986)</a>
@see
@ref remove_password,
@ref set_encoded_password,
@ref set_password,
@ref set_user.
*/
url_base&
set_encoded_user(
pct_string_view s);
/** Set the password.
This function sets the password in
the userinfo to the string.
Reserved characters in the string are
percent-escaped in the result.
@note
The interpretation of the userinfo as
individual user and password components
is scheme-dependent. Transmitting
passwords in URLs is deprecated.
@par Example
@code
assert( url("http://user@example.com").set_password( "pass" ).encoded_userinfo() == "user:pass" );
@endcode
@par Postconditions
@code
this->has_password() == true && this->password() == s
@endcode
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
@param s The string to set. This string may
contain any characters, including nulls.
@par BNF
@code
userinfo = [ [ user ] [ ':' password ] ]
user = *( unreserved / pct-encoded / sub-delims )
password = *( unreserved / pct-encoded / sub-delims / ":" )
@endcode
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1">
3.2.1. User Information (rfc3986)</a>
@see
@ref remove_password,
@ref set_encoded_password,
@ref set_encoded_user,
@ref set_user.
*/
url_base&
set_password(
core::string_view s);
/** Set the password.
This function sets the password in
the userinfo to the string, which
may contain percent-escapes.
Escapes in the string are preserved,
and reserved characters in the string
are percent-escaped in the result.
@note
The interpretation of the userinfo as
individual user and password components
is scheme-dependent. Transmitting
passwords in URLs is deprecated.
@par Example
@code
assert( url("http://user@example.com").set_encoded_password( "pass" ).encoded_userinfo() == "user:pass" );
@endcode
@par Postconditions
@code
this->has_password() == true
@endcode
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
@throw system_error
`s` contains an invalid percent-encoding.
@param s The string to set. This string may
contain any characters, including nulls.
@par BNF
@code
userinfo = [ [ user ] [ ':' password ] ]
user = *( unreserved / pct-encoded / sub-delims )
password = *( unreserved / pct-encoded / sub-delims / ":" )
@endcode
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1">
3.2.1. User Information (rfc3986)</a>
@see
@ref remove_password,
@ref set_encoded_password,
@ref set_encoded_user,
@ref set_user.
*/
url_base&
set_encoded_password(
pct_string_view s);
/** Remove the password
This function removes the password from
the userinfo if a password exists. If
there is no userinfo or no authority,
the call has no effect.
@note
The interpretation of the userinfo as
individual user and password components
is scheme-dependent. Transmitting
passwords in URLs is deprecated.
@par Example
@code
assert( url( "http://user:pass@example.com" ).remove_password().authority().buffer() == "user@example.com" );
@endcode
@par Postconditions
@code
this->has_password() == false && this->encoded_password().empty() == true
@endcode
@par Complexity
Linear in `this->size()`.
@par Exception Safety
Throws nothing.
@par BNF
@code
userinfo = [ [ user ] [ ':' password ] ]
user = *( unreserved / pct-encoded / sub-delims )
password = *( unreserved / pct-encoded / sub-delims / ":" )
@endcode
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1">
3.2.1. User Information (rfc3986)</a>
@see
@ref set_encoded_password,
@ref set_encoded_user,
@ref set_password,
@ref set_user.
*/
url_base&
remove_password() noexcept;
//--------------------------------------------
//
// Host
//
//--------------------------------------------
/** Set the host
Depending on the contents of the passed
string, this function sets the host:
@li If the string is a valid IPv4 address,
then the host is set to the address.
The host type is @ref host_type::ipv4.
@li If the string is a valid IPv6 address
enclosed in square brackets, then the
host is set to that address.
The host type is @ref host_type::ipv6.
@li If the string is a valid IPvFuture
address enclosed in square brackets, then
the host is set to that address.
The host type is @ref host_type::ipvfuture.
@li Otherwise, the host name is set to
the string, which may be empty.
Reserved characters in the string are
percent-escaped in the result.
The host type is @ref host_type::name.
In all cases, when this function returns,
the URL contains an authority.
@par Example
@code
assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" );
@endcode
@par Postconditions
@code
this->has_authority() == true
@endcode
@par Complexity
Linear in `this->size() + s.size()`.
@par Exception Safety
Strong guarantee.
Calls to allocate may throw.
@param s The string to set.
@par BNF
@code
host = IP-literal / IPv4address / reg-name
IP-literal = "[" ( IPv6address / IPvFuture ) "]"
reg-name = *( unreserved / pct-encoded / "-" / ".")
@endcode
@par Specification
@li <a href="https://en.wikipedia.org/wiki/IPv4"
>IPv4 (Wikipedia)</a>
@li <a href="https://datatracker.ietf.org/doc/html/rfc4291"
>IP Version 6 Addressing Architecture (rfc4291)</a>
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2">
3.2.2. Host (rfc3986)</a>
@see
@ref set_encoded_host,
@ref set_encoded_host_address,
@ref set_encoded_host_name,
@ref set_host_address,
@ref set_host_ipv4,
@ref set_host_ipv6,
@ref set_host_ipvfuture,
@ref set_host_name.
*/
url_base&
set_host(
core::string_view s);
/** Set the host
Depending on the contents of the passed
string, this function sets the host:
@li If the string is a valid IPv4 address,
then the host is set to the address.
The host type is @ref host_type::ipv4.
@li If the string is a valid IPv6 address
enclosed in square brackets, then the
host is set to that address.
The host type is @ref host_type::ipv6.
@li If the string is a valid IPvFuture
address enclosed in square brackets, then
the host is set to that address.
The host type is @ref host_type::ipvfuture.
@li Otherwise, the host name is set to
the string. This string can contain percent
escapes, or can be empty.
Escapes in the string are preserved,
and reserved characters in the string
are percent-escaped in the result.
The host type is @ref host_type::name.
In all cases, when this function returns,
the URL contains an authority.
@par Example
@code
assert( url( "http://www.example.com" ).set_host( "127.0.0.1" ).buffer() == "http://127.0.0.1" );
@endcode
@par Postconditions
@code
this->has_authority() == true
@endcode
@par Complexity
Linear in `this->size() + s.size()`.