[#boost-urls-segments_base-front]
= xref:boost/urls/segments_base/front.adoc[boost::urls::segments_base::front]
:relfileprefix: ../../../
:mrdocs:

Return the first segment

== Synopsis

Declared in `<https://www.github.com/boostorg/url/blob/develop/include/boost/url/segments_base.hpp#L249[boost/url/segments_base.hpp]>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::string
front() const noexcept;
----

== Description

This function returns a string with the first segment of the path without any leading or trailing '/' separators. Any percent‐escapes in the string are decoded first.

== Preconditions
[,cpp]
----
this->empty() == false
----
== Effects
[,cpp]
----
return *begin();
----
== Example
[,cpp]
----
assert( url_view( "/path/to/file.txt" ).segments().front() == "path" );
----
== Complexity
Linear in `this‐>front().size()`.

== Exception Safety
Calls to allocate may throw.

== Return Value

The first segment.


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