authority_view

A non-owning reference to a valid authority

Synopsis

class authority_view ;

Declared in file <boost/url/authority_view.hpp> at line 82

Member Functions

Name Description
~authority_view

Destructor

authority_view

Constructor

authority_view

Construct from a string.

authority_view

Constructor

operator=

Assignment

size

Return the number of characters in the authority

empty

Return true if the authority is empty

data

Return a pointer to the first character

buffer

Return the complete authority

has_userinfo

Return true if a userinfo is present

userinfo

Return the userinfo

encoded_userinfo

Return the userinfo

user

Return the user

encoded_user

Return the user

has_password

Return true if a password is present

password

Return the password

encoded_password

Return the password

host_type

Return the host type

host

Return the host

encoded_host

Return the host

host_address

Return the host

encoded_host_address

Return the host

host_ipv4_address

Return the host IPv4 address

host_ipv6_address

Return the host IPv6 address

host_ipvfuture

Return the host IPvFuture address

host_name

Return the host name

encoded_host_name

Return the host name

has_port

Return true if a port is present

port

Return the port

port_number

Return the port

encoded_host_and_port

Return the host and port

compare

Return the result of comparing this with another authority

Description

Objects of this type represent valid authority strings constructed from a parsed, external character buffer whose storage is managed by the caller. That is, it acts like a `core::string_view` in terms of ownership. The caller is responsible for ensuring that the lifetime of the underlying character buffer extends until it is no longer referenced.

Example 1

Construction from a string parses the input as an authority and throws an exception on error. Upon success, the constructed object points to the passed character buffer; ownership is not transferred.

authority_view a( "user:pass@www.example.com:8080" );

Example 2

The parsing function parse_authority returns a result containing either a valid authority_view upon succcess, otherwise it contain an error. The error can be converted to an exception by the caller if desired:

system::result< authority_view > rv = parse_authority( "user:pass@www.example.com:8080" );

BNF

authority = [ userinfo "@" ] host [ ":" port ] userinfo = user [ ":" [ password ] ] user = *( unreserved / pct-encoded / sub-delims ) password = *( unreserved / pct-encoded / sub-delims / ":" ) host = IP-literal / IPv4address / reg-name port = *DIGIT

Specification

  • 3.2. Authority (rfc3986)