Class segments_ref
A view representing path segments in a URL
Synopsis
class segments_ref
: public segments_base;Defined in file <include/boost/url/segments_ref.hpp> on line 85
Member Functions
Name |
Description |
Constructor |
|
Assignment |
|
Assignment |
|
Conversion |
|
Return the referenced url |
|
Clear the contents of the container |
|
Assign segments |
|
Assign segments |
|
Insert segments |
|
Insert segments |
|
Insert segments |
|
Erase segments |
|
Erase segments |
|
Replace segments |
|
Replace segments |
|
Replace segments |
|
Replace segments |
|
Append a segment |
|
Remove the last segment |
Description
Objects of this type are used to interpret the path as a bidirectional view of segments, where each segment is a string with percent escapes automatically decoded. 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. The view is modifiable; calling non-const members causes changes to the referenced url.
Example
url u( "/path/to/file.txt" );
segments_ref ps = u.segments();Percent escapes in strings returned when dereferencing iterators are automatically decoded. Reserved characters in strings supplied to modifier functions are automatically percent-escaped.
Iterator Invalidation
Changes to the underlying character buffer can invalidate iterators which reference it. Modifications made through the container invalidate some or all iterators:
-
push_back : Only
end(). -
assign, clear, ../../reference/boost/urls/segments_ref/operator_assign-0d.adoc : All elements.
-
erase : Erased elements and all elements after (including
end()). -
insert : All elements at or after the insertion point (including
end()). -
replace : Modified elements and all elements after (including
end()).