boost::urls::url_base::segments

Return the path as a container of segments

Synopsis

Declared in <boost/url/url_base.hpp>

urls::segments_ref
segments() noexcept;

Description

This function returns a bidirectional view of segments over the path. The returned view references the same underlying character buffer; ownership is not transferred. Any percent‐escapes in strings returned when iterating the view are decoded first. The container is modifiable; changes to the container are reflected in the underlying URL.

Example

url u( "http://example.com/path/to/file.txt" );

segments sv = u.segments();

Complexity

Constant.

Exception Safety

Throws nothing.

BNF

path          = path-abempty    ; begins with "/" or is empty
              / path-absolute   ; begins with "/" but not "//"
              / path-noscheme   ; begins with a non-colon segment
              / path-rootless   ; begins with a segment
              / path-empty      ; zero characters

path-abempty  = *( "/" segment )
path-absolute = "/" [ segment-nz *( "/" segment ) ]
path-noscheme = segment-nz-nc *( "/" segment )
path-rootless = segment-nz *( "/" segment )
path-empty    = 0<pchar>

Specification

https://datatracker.ietf.org/doc/html/rfc3986#section-3.3

Return Value

*this