A view representing path segments in a URL
class segments_ref
: public segments_base;
Declared in file <boost/url/segments_ref.hpp> at line 85
| Name | Description |
|---|---|
| iterator |
| Name | Description |
|---|---|
| const_iterator | iterator |
| value_type | The value type |
| reference | The reference type |
| const_reference | The reference type |
| size_type | An unsigned integer type used to represent size. |
| difference_type | A signed integer type used to represent differences. |
| Name | Description |
|---|---|
| buffer | Return the referenced character buffer. |
| is_absolute | Returns true if this references an absolute path. |
| empty | Return true if there are no segments |
| size | Return the number of segments |
| front | Return the first segment |
| back | Return the last segment |
| begin | Return an iterator to the beginning |
| end | Return an iterator to the end |
| segments_ref | Constructor |
| operator= | Assignment |
| operator= | |
| operator= | Assignment |
| operator segments_view | Conversion |
| url | Return the referenced url |
| clear | Clear the contents of the container |
| assign | Assign segments |
| assign | Assign segments |
| insert | Insert segments |
| insert | Insert segments |
| insert | Insert segments |
| erase | Erase segments |
| erase | Erase segments |
| replace | Replace segments |
| replace | Replace segments |
| replace | Replace segments |
| replace | Replace segments |
| push_back | Append a segment |
| pop_back | Remove the last segment |
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.
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.
Changes to the underlying character buffer can invalidate iterators which reference it. Modifications made through the container invalidate some or all iterators: