[#boost-urls-segments_encoded_view]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::segments&lowbar;encoded&lowbar;view
:relfileprefix: ../../
:mrdocs:


A view representing path segments in a URL

== Synopsis


Declared in `&lt;https://www.github.com/boostorg/url/blob/develop/include/boost/url/segments_encoded_view.hpp#L61[boost&sol;url&sol;segments&lowbar;encoded&lowbar;view&period;hpp]&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class segments&lowbar;encoded&lowbar;view
    : public xref:boost/urls/segments_encoded_base.adoc[segments&lowbar;encoded&lowbar;base];
----

== Types

[cols=2]
|===
| Name | Description 

| xref:boost/urls/segments_encoded_base/const_iterator.adoc[`const&lowbar;iterator`] 
| A Bidirectional iterator to a path segment

| xref:boost/urls/segments_encoded_base/const_reference.adoc[`const&lowbar;reference`] 
| The reference type

| xref:boost/urls/segments_encoded_base/difference_type.adoc[`difference&lowbar;type`] 
| A signed integer type used to represent differences&period;

| xref:boost/urls/segments_encoded_base/iterator.adoc[`iterator`] 
| A Bidirectional iterator to a path segment

| xref:boost/urls/segments_encoded_base/reference.adoc[`reference`] 
| The reference type

| xref:boost/urls/segments_encoded_base/size_type.adoc[`size&lowbar;type`] 
| An unsigned integer type used to represent size&period;

| xref:boost/urls/segments_encoded_base/value_type.adoc[`value&lowbar;type`] 
| The value type

|===
== Member Functions

[cols=2]
|===
| Name | Description 

| xref:boost/urls/segments_encoded_base/back.adoc[`back`] 
| Return the last segment

| xref:boost/urls/segments_encoded_base/begin.adoc[`begin`] 
| Return an iterator to the beginning

| xref:boost/urls/segments_encoded_base/buffer.adoc[`buffer`] 
| Return the referenced character buffer&period;

| xref:boost/urls/segments_encoded_base/empty.adoc[`empty`] 
| Return true if there are no segments

| xref:boost/urls/segments_encoded_base/end.adoc[`end`] 
| Return an iterator to the end

| xref:boost/urls/segments_encoded_base/front.adoc[`front`] 
| Return the first segment

| xref:boost/urls/segments_encoded_base/is_absolute.adoc[`is&lowbar;absolute`] 
| Returns true if this references an absolute path&period;

| xref:boost/urls/segments_encoded_view/2conversion.adoc[`operator segments&lowbar;view`] 
| Conversion

| xref:boost/urls/segments_encoded_view/operator_assign.adoc[`operator&equals;`] 
| Assignment

| xref:boost/urls/segments_encoded_view/2constructor.adoc[`segments&lowbar;encoded&lowbar;view`]         [.small]#[constructor]#
| Constructor


| xref:boost/urls/segments_encoded_base/size.adoc[`size`] 
| Return the number of segments

|===
== Static Member Functions

[cols=2]
|===
| Name | Description 

| xref:boost/urls/segments_encoded_base/max_size.adoc[`max&lowbar;size`] 
| Return the maximum number of characters possible

|===
== Friends

[cols=1]
|===
| Name 

| xref:boost/urls/segments_encoded_view/08friend-01.adoc[`parse&lowbar;path`] 
|===



== Description


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

The view does not retain ownership of the    elements and instead references the original    character buffer&period; The caller is responsible    for ensuring that the lifetime of the buffer    extends until it is no longer referenced&period;


=== Example

[,cpp]
----
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 xref:boost/urls/param_pct_view.adoc[param&lowbar;pct&lowbar;view] and represent    encoded strings&period; Strings passed to member    functions may contain percent escapes, and    throw exceptions on invalid inputs&period;


=== Iterator Invalidation

Changes to the underlying character buffer    can invalidate iterators which reference it&period;



== See Also


xref:boost/urls/segments_view.adoc[segments&lowbar;view],        xref:boost/urls/segments_encoded_ref.adoc[segments&lowbar;encoded&lowbar;ref],        xref:boost/urls/segments_ref.adoc[segments&lowbar;ref]&period;






[.small]#Created with https://www.mrdocs.com[MrDocs]#
