boost::urls::url_view_base::fragment

Return the fragment

Synopsis

Declared in <boost/url/url_view_base.hpp>

template<string_token::StringToken StringToken = string_token::return_string>
StringToken::result_type
fragment(StringToken&& token = {});

Description

This function calculates the fragment of the url, with percent escapes decoded and without the leading pound sign ('#') whose presence indicates that the url contains a fragment.

This function accepts an optional StringToken parameter which controls the return type and behavior of the function:

  • When called with no arguments, the return type of the function is std::string. Otherwise

  • When called with a string token, the behavior and return type of the function depends on the type of string token being passed.

Example

assert( url_view( "http://www.example.com/index.htm#a%2D1" ).fragment() == "a-1" );

Complexity

Linear in this‐>fragment().size().

Exception Safety

Calls to allocate may throw. String tokens may throw exceptions.

BNF

fragment        = *( pchar / "/" / "?" )

fragment-part   = [ "#" fragment ]

Specification

Return Value

The fragment portion of the url.

Parameters

Name

Description

token

An optional string token to use. If this parameter is omitted, the function returns a new std::string.

See Also

encoded_fragment, has_fragment.

Created with MrDocs