Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the master branch, built from commit 5002c2d6a2.
PrevUpHomeNext

segments_encoded_ref

A view representing path segments in a URL.

Synopsis

Defined in header <boost/url/segments_encoded_ref.hpp>

class segments_encoded_ref :
    public segments_encoded_base
Types

Name

Description

const_iterator

A Bidirectional iterator to a path segment.

const_reference

The reference type.

difference_type

A signed integer type used to represent differences.

iterator

A Bidirectional iterator to a path segment.

reference

The reference type.

size_type

An unsigned integer type used to represent size.

value_type

The value type.

Member Functions

Name

Description

assign

Assign segments.

back

Return the last segment.

begin

Return an iterator to the beginning.

buffer

Return the referenced character buffer.

clear

Clear the contents of the container.

empty

Return true if there are no segments.

end

Return an iterator to the end.

erase

Erase segments.

front

Return the first segment.

insert

Insert segments.

is_absolute

Returns true if this references an absolute path.

operator=

Assignment.

operator segments_encoded_view

Conversion.

pop_back

Remove the last segment.

push_back

Append a segment.

replace

Replace segments.

segments_encoded_ref [constructor]

Constructor.

size

Return the number of segments.

url

Return the referenced url.

Static Member Functions

Name

Description

max_size

Return the maximum number of characters possible.

operator=

Assignment.

Description

Objects of this type are used to interpret the path as a bidirectional view of segments, where each segment is a string which may contain percent-escapes. 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 will cause changes to the referenced url.

Example
url u( "/path/to/file.txt" );

segments_encoded_ref ps = u.encoded_segments();

The strings returned when iterators are dereferenced have type pct_string_view and may contain percent-escapes. Reserved characters in inputs are automatically escaped. Escapes in inputs are preserved. Exceptions are thrown on invalid inputs.

Iterator Invalidation

Changes to the underlying character buffer can invalidate iterators which reference it. Modifications made through the container will invalidate some or all iterators:

See Also

segments_encoded_view, segments_view, segments_ref.

Convenience header <boost/url.hpp>


PrevUpHomeNext