-
Notifications
You must be signed in to change notification settings - Fork 54
/
Copy pathsegments_encoded_view.hpp
240 lines (186 loc) · 5.74 KB
/
segments_encoded_view.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
//
// 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_SEGMENTS_ENCODED_VIEW_HPP
#define BOOST_URL_SEGMENTS_ENCODED_VIEW_HPP
#include <boost/url/detail/config.hpp>
#include <boost/url/error_types.hpp>
#include <boost/url/segments_encoded_base.hpp>
#include <boost/url/segments_view.hpp>
#include <boost/core/detail/string_view.hpp>
#include <iosfwd>
#include <utility>
namespace boost {
namespace urls {
/** A view representing path segments in a URL
Objects of this type are used to interpret
the path as a bidirectional view of segment
strings.
The view does not retain ownership of the
elements and instead references the original
character buffer. The caller is responsible
for ensuring that the lifetime of the buffer
extends until it is no longer referenced.
@par Example
@code
url_view u( "/path/to/file.txt" );
segments_encoded_view ps = u.encoded_segments();
assert( ps.buffer().data() == u.buffer().data() );
@endcode
Strings produced when elements are returned
have type @ref param_pct_view and represent
encoded strings. Strings passed to member
functions may contain percent escapes, and
throw exceptions on invalid inputs.
@par Iterator Invalidation
Changes to the underlying character buffer
can invalidate iterators which reference it.
@see
@ref segments_view,
@ref segments_encoded_ref,
@ref segments_ref.
*/
class segments_encoded_view
: public segments_encoded_base
{
friend class url_view_base;
friend class segments_encoded_ref;
segments_encoded_view(
detail::path_ref const& ref) noexcept;
public:
/** Constructor
Default-constructed segments have
zero elements.
@par Example
@code
segments_encoded_view ps;
@endcode
@par Effects
@code
return segments_encoded_view( "" );
@endcode
@par Complexity
Constant.
@par Exception Safety
Throws nothing.
*/
segments_encoded_view() = default;
/** Constructor
After construction, both views
reference the same character buffer.
Ownership is not transferred; the caller
is responsible for ensuring the lifetime
of the buffer extends until it is no
longer referenced.
@par Postconditions
@code
this->buffer().data() == other.buffer().data()
@endcode
@par Complexity
Constant.
@par Exception Safety
Throws nothing
*/
segments_encoded_view(
segments_encoded_view const&) noexcept = default;
/** Constructor
This function constructs segments from
a valid path string, which can contain
percent escapes.
Upon construction, the view references
the character buffer pointed to by `s`.
caller is responsible for ensuring
that the lifetime of the buffer
extends until the view is destroyed.
@par Example
@code
segments_encoded_view ps( "/path/to/file.txt" );
@endcode
@par Effects
@code
return parse_path( s ).value();
@endcode
@par Postconditions
@code
this->buffer().data() == s.data()
@endcode
@par Complexity
Linear in `s`.
@par Exception Safety
Exceptions thrown on invalid input.
@throw system_error
`s` contains an invalid path.
@param s The string to parse.
@par BNF
@code
path = [ "/" ] [ segment *( "/" segment ) ]
segment = *pchar
@endcode
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3.3"
>3.3. Path</a>
*/
BOOST_URL_DECL
segments_encoded_view(
core::string_view s);
/** Assignment
After assignment, both views
reference the same underlying character
buffer.
Ownership is not transferred; the caller
is responsible for ensuring the lifetime
of the buffer extends until it is no
longer referenced.
@par Postconditions
@code
this->buffer().data() == other.buffer().data()
@endcode
@par Complexity
Constant
@par Exception Safety
Throws nothing
*/
segments_encoded_view&
operator=(
segments_encoded_view const&) = default;
/** Conversion
This conversion returns a new view which
references the same underlying character
buffer, and whose iterators and members
return ordinary strings with decoding
applied to any percent escapes.
Ownership is not transferred; the caller
is responsible for ensuring the lifetime
of the buffer extends until it is no
longer referenced.
@par Example
@code
segments_view ps = parse_path( "/path/to/file.txt" ).value();
@endcode
@par Postconditions
@code
segments_view( *this ).buffer().data() == this->buffer().data()
@endcode
@par Complexity
Constant
@par Exception Safety
Throws nothing
*/
BOOST_URL_DECL
operator
segments_view() const noexcept;
//--------------------------------------------
BOOST_URL_DECL
friend
system::result<segments_encoded_view>
parse_path(core::string_view s) noexcept;
};
} // urls
} // boost
#endif