boost::urls::segments_encoded_view

Non‐owning encoded path segment view

Synopsis

class segments_encoded_view
    : public segments_encoded_base

Base Classes

Name Description

segments_encoded_base

Percent‐encoded path segment helper base

Types

Name

Description

iterator

A Bidirectional iterator to a path segment

const_iterator

A Bidirectional iterator to a path segment

const_reference

The reference type

difference_type

A signed integer type used to represent differences.

reference

The reference type

size_type

An unsigned integer type used to represent size.

value_type

The value type

Member Functions

Name

Description

segments_encoded_view [constructor]

Constructor

operator=

Assignment

back

Return the last segment

begin

Return an iterator to the beginning

buffer

Return the referenced character buffer.

empty

Return true if there are no segments

end

Return an iterator to the end

front

Return the first segment

is_absolute

Returns true if this references an absolute path.

size

Return the number of segments

operator segments_view

Conversion

Static Member Functions

Name

Description

max_size

Return the maximum number of characters possible

Friends

Name Description

boost::urls::parse_path

Parse a string and return an encoded segment view

boost::urls::segments_encoded_ref

Mutable encoded path segment proxy

boost::urls::url_view_base

Common functionality for containers

Description

Exposes the raw percent‐encoded segments of a URL path as a read‐only bidirectional range. The view references the original buffer, so callers must keep that storage alive while iterating.

Example

url_view u( "/path/to/file.txt" );

segments_encoded_view ps = u.encoded_segments();

assert( ps.buffer().data() == u.buffer().data() );

Elements are returned as encoded strings, preserving escape sequences for callers that need the exact byte representation.

Iterator Invalidation

Changes to the underlying character buffer can invalidate iterators which reference it.