:relfileprefix: ../../../
[#boost-urls-segments_base-front]

= xref:boost.adoc[pass:[boost]]::xref:boost/urls.adoc[pass:[urls]]::xref:boost/urls/segments_base.adoc[pass:[segments_base]]::front


Return the first segment


== Synopsis

Declared in header `<https://www.github.com/boostorg/url/blob/develop/include/boost/url/segments_base.hpp#L241[boost/url/segments_base.hpp,window=blank_]>`

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

== Description


This function returns a string with the
first segment of the path without any
leading or trailing '&sol;' 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-&gt;front().size()`.

=== Exception Safety

Calls to allocate may throw.