20122012 Ericsson AB. All Rights Reserved. The contents of this file are subject to the Erlang Public License, Version 1.1, (the "License"); you may not use this file except in compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. http_uri
http_uri URI utility module

This module provides utility functions for working with URIs, according to RFC 3986.

COMMON DATA TYPES

Type definitions that are used more than once in this module:

URI DATA TYPES

Type definitions that are related to URI:

For more information about URI, see RFC 3986.

scheme_defaults() -> SchemeDefaults A list of scheme and their default ports SchemeDefaults = [{scheme(), default_scheme_port_number()}] default_scheme_port_number() = pos_integer()

This function provides a list of the scheme and their default port numbers currently supported (by default) by this utility.

parse(URI) -> {ok, Result} | {error, Reason} parse(URI, Options) -> {ok, Result} | {error, Reason} Parse an URI URI = uri() Options = [Option] Option = {ipv6_host_with_brackets, boolean()} | {scheme_defaults, scheme_defaults()}] Result = {Scheme, UserInfo, Host, Port, Path, Query} UserInfo = user_info() Host = host() Port = pos_integer() Path = path() Query = query() Reason = term()

This function is used to parse an URI. If no scheme defaults are provided, the value of scheme_defaults function will be used.

Note that when parsing an URI with an unknown scheme (that is, a scheme not found in the scheme defaults) a port number must be provided or else the parsing will fail.

encode(URI) -> HexEncodedURI Hex encode an URI URI = uri() HexEncodedURI = string() - Hex encoded uri

Hex encode an URI.

decode(HexEncodedURI) -> URI Decode a hex encoded URI HexEncodedURI = string() - A possibly hex encoded uri URI = uri()

Decode a possibly hex encoded URI.