:relfileprefix: ../../
[#81EF5C3814CDD7DCB06D54E70796A3749502E3A4]

= Class segments_base

pass:v,q[Common functionality for containers]


== Synopsis

Declared in header `</boost/url/segments_base.hpp#L37[boost/url/segments_base.hpp,window=blank_]>`

[source,cpp,subs="verbatim,macros,-callouts"]
----
class segments_base;
----

==  Types
[,cols=2]
|===
|Name |Description
|xref:boost/urls/segments_base/const_iterator.adoc[`pass:v[const_iterator]`] |
xref:boost/urls/segments_base/iterator.adoc[iterator]

|xref:boost/urls/segments_base/const_reference.adoc[`pass:v[const_reference]`] |
pass:v,q[The reference type]

|xref:boost/urls/segments_base/difference_type.adoc[`pass:v[difference_type]`] |
pass:v,q[A signed integer type used to represent differences.]

|xref:boost/urls/segments_base/iterator.adoc[`pass:v[iterator]`] |

|xref:boost/urls/segments_base/reference.adoc[`pass:v[reference]`] |
pass:v,q[The reference type]

|xref:boost/urls/segments_base/size_type.adoc[`pass:v[size_type]`] |
pass:v,q[An unsigned integer type used to represent size.]

|xref:boost/urls/segments_base/value_type.adoc[`pass:v[value_type]`] |
pass:v,q[The value type]

|===
==  Member Functions
[,cols=2]
|===
|Name |Description
|xref:boost/urls/segments_base/back.adoc[`pass:v[back]`] |
pass:v,q[Return the last segment]

|xref:boost/urls/segments_base/begin.adoc[`pass:v[begin]`] |
pass:v,q[Return an iterator to the beginning]

|xref:boost/urls/segments_base/buffer.adoc[`pass:v[buffer]`] |
pass:v,q[Return the referenced character buffer.]

|xref:boost/urls/segments_base/empty.adoc[`pass:v[empty]`] |
pass:v,q[Return true if there are no segments]

|xref:boost/urls/segments_base/end.adoc[`pass:v[end]`] |
pass:v,q[Return an iterator to the end]

|xref:boost/urls/segments_base/front.adoc[`pass:v[front]`] |
pass:v,q[Return the first segment]

|xref:boost/urls/segments_base/is_absolute.adoc[`pass:v[is_absolute]`] |
pass:v,q[Returns true if this references an absolute path.]

|xref:boost/urls/segments_base/size.adoc[`pass:v[size]`] |
pass:v,q[Return the number of segments]

|===
==  Static Member Functions
[,cols=2]
|===
|Name |Description
|xref:boost/urls/segments_base/max_size.adoc[`pass:v[max_size]`] |
pass:v,q[Return the maximum number of characters possible]

|===

== Description

pass:v,q[This base class is used by the library] pass:v,q[to provide common member functions for]
pass:v,q[containers. This cannot be instantiated]
pass:v,q[directly; Instead, use one of the]
pass:v,q[containers or functions:]

=== Containers

* xref:boost/urls/segments_ref.adoc[segments_ref]

* xref:boost/urls/segments_view.adoc[segments_view]

* xref:boost/urls/segments_encoded_ref.adoc[segments_encoded_ref]

* xref:boost/urls/segments_encoded_view.adoc[segments_encoded_view]