boost::urls::segments_encoded_view

A view representing path segments in a URL

Synopsis

Declared in <boost/url/segments_encoded_view.hpp>

class segments_encoded_view
    : public segments_encoded_base

Base Classes

Name	Description
`segments_encoded_base`	Common functionality for containers

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
`parse_path`	Parse a string and return an encoded segment view
`segments_encoded_ref`	A view representing path segments in a URL
`url_view_base`	Common functionality for containers

Description

Objects of this type are used to interpret the path as a bidirectional view of segment strings.

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.

Example


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

segments_encoded_view ps = u.encoded_segments();

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

Strings produced when elements are returned have type param_pct_view and represent encoded strings. Strings passed to member functions may contain percent escapes, and throw exceptions on invalid inputs.

Iterator Invalidation

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