boost::urls :: Boost Libraries Documentation

# boost::urls

## Namespaces

Name
`error_types`
`grammar`
`string_token`

## Types

Name | Description
`authority_view` | A non‐owning reference to a valid authority
`decode_view` | A reference to a valid, percent‐encoded string
`encoding_opts` | Percent‐encoding options
`ignore_case_param` | An optional parameter to determine case‐sensitivity
`ipv4_address` | An IP version 4 style address.
`ipv6_address` | An IP version 6 style address.
`no_value_t` | The type of `no_value`
`param` | A query parameter
`param_pct_view` | A view of a percent‐encoded query parameter
`param_view` | A view of a query parameter
`params_base` | Decoded query parameter helper base
`params_encoded_base` | Percent‐encoded query helper base
`params_encoded_ref` | Mutable encoded query parameter proxy
`params_encoded_view` | Non‐owning encoded query parameter view
`params_ref` | Mutable decoded query parameter proxy
`params_view` | Non‐owning decoded query parameter view
`pct_string_view` | A reference to a valid percent‐encoded string
`segments_base` | Decoded path segment helper base
`segments_encoded_base` | Percent‐encoded path segment helper base
`segments_encoded_ref` | Mutable encoded path segment proxy
`segments_encoded_view` | Non‐owning encoded path segment view
`segments_ref` | Mutable decoded path segment proxy
`segments_view` | Non‐owning decoded path segment view
`static_url` | A modifiable container for a URL.
`static_url_base` | Common implementation for all static URLs
`url` | A modifiable container for a URL.
`url_base` | Common functionality for containers
`url_view` | A non‐owning reference to a valid URL
`url_view_base` | Common functionality for containers
`format_arg` | A temporary reference to a formatting argument
`named_arg` | A temporary reference to a named formatting argument
`optional` | The type of optional used by the library
`string_view` | The type of string_view used by the library
`variant` | The type of variant used by the library

## Enums

Name | Description
`error` | Error codes returned the library
`host_type` | Identifies the type of host in a URL.
`scheme` | Identifies a known URL scheme

## Functions

Name | Description
`arg` | Designate a named argument for a replacement field
`decode` | `decode` overloads
`decoded_size` | Return the buffer size needed for percent‐decoding
`default_port` | Return the default port for a known scheme
`encode` | `encode` overloads
`encoded_size` | Return the buffer size needed for percent‐encoding
`format` | Format arguments into a URL
`format_to` | Format arguments into a URL
`make_pct_string_view` | Return a valid percent‐encoded string
`parse_absolute_uri` | Return a reference to a parsed URL string
`parse_authority` | Parse an authority
`parse_ipv4_address` | Return an IPv4 address from an IP address string in dotted decimal form
`parse_ipv6_address` | Parse a string containing an IPv6 address.
`parse_origin_form` | Return a reference to a parsed URL string
`parse_path` | Parse a string and return an encoded segment view
`parse_query` | Parse a string and return an encoded params view
`parse_relative_ref` | Return a reference to a parsed URL string
`parse_uri` | Return a reference to a parsed URL string
`parse_uri_reference` | Return a reference to a parsed URL string
`pct_encoded_rule` | Rule for a string with percent‐encoded escapes
`resolve` | Resolve a URL reference against a base URL
`string_to_scheme` | Return the known scheme for a non‐normalized string, if known
`swap` | Swap
`to_string` | Return the normalized string for a known scheme
`operator<<` | Stream insertion operators
`operator==` | Equality operators
`operator!=` | Inequality operators
`operator<` | Less‐than operators
`operator<=` | Less‐than‐or‐equal operators
`operator>` | Greater‐than operators
`operator>=` | Greater‐than‐or‐equal operators

## Variables

Name | Description
`absolute_uri_rule` | Rule for absolute‐URI
`authority_rule` | Rule for authority
`gen_delim_chars` | The gen‐delims character set
`ignore_case` | Ignore case when comparing
`ipv4_address_rule` | Rule for an IP version 4 style address
`ipv6_address_rule` | Rule for An IP version 6 style address
`no_value` | Constant indicating no value in a param
`origin_form_rule` | Rule for origin‐form
`pchars` | The path character set
`query_rule` | Rule for a query string
`relative_ref_rule` | Rule for relative‐ref
`reserved_chars` | The reserved character set
`sub_delim_chars` | The sub‐delims character set
`unreserved_chars` | The unreserved character set
`uri_reference_rule` | Rule for URI‐reference
`uri_rule` | Rule for URI

## Using Namespace Directives

Name
`error_types`

Created with MrDocs