CAF  0.17.3
Classes | Public Types | Public Member Functions | Friends | Related Functions | List of all members
caf::uri Class Reference

A URI according to RFC 3986. More...

#include <uri.hpp>

Inheritance diagram for caf::uri:
caf::detail::comparable< uri > caf::detail::comparable< uri, string_view >


struct  authority_type
 Bundles the authority component of the URI, i.e., userinfo, host, and port. More...

Public Types

using impl_ptr = intrusive_ptr< const detail::uri_impl >
 Pointer to implementation.
using host_type = variant< std::string, ip_address >
 Host subcomponent of the authority component. More...
using path_list = std::vector< string_view >
 Separates the query component into key-value pairs.
using query_map = detail::unordered_flat_map< std::string, std::string >
 Separates the query component into key-value pairs.

Public Member Functions

 uri (uri &&)=default
 uri (const uri &)=default
urioperator= (uri &&)=default
urioperator= (const uri &)=default
 uri (impl_ptr ptr)
bool empty () const noexcept
 Returns whether all components of this URI are empty.
string_view str () const noexcept
 Returns the full URI as provided by the user.
string_view scheme () const noexcept
 Returns the scheme component.
const authority_typeauthority () const noexcept
 Returns the authority component.
string_view path () const noexcept
 Returns the path component as provided by the user.
const query_mapquery () const noexcept
 Returns the query component as key-value map.
string_view fragment () const noexcept
 Returns the fragment component.
size_t hash_code () const noexcept
 Returns a hash code over all components.
optional< uriauthority_only () const
 Returns a new URI with the authority component only. More...
int compare (const uri &other) const noexcept
int compare (string_view x) const noexcept


CAF_CORE_EXPORT error inspect (caf::serializer &dst, uri &x)
CAF_CORE_EXPORT error_code< secinspect (caf::binary_serializer &dst, uri &x)
CAF_CORE_EXPORT error inspect (caf::deserializer &src, uri &x)
error_code< secinspect (caf::binary_deserializer &src, uri &x)

Related Functions

(Note that these are not member functions.)

CAF_CORE_EXPORT std::string to_string (const uri &x)
CAF_CORE_EXPORT std::string to_string (const uri::authority_type &x)
CAF_CORE_EXPORT error parse (string_view str, uri &dest)
CAF_CORE_EXPORT expected< urimake_uri (string_view str)

Detailed Description

A URI according to RFC 3986.

Member Typedef Documentation

◆ host_type

using caf::uri::host_type = variant<std::string, ip_address>

Host subcomponent of the authority component.

Either an IP address or an hostname as string.

Member Function Documentation

◆ authority_only()

optional<uri> caf::uri::authority_only ( ) const

Returns a new URI with the authority component only.

A new URI in the form scheme://authority if the authority exists, otherwise none.`

The documentation for this class was generated from the following file: