From a42858f00ba09759d5f723895e52cd89c77165ac Mon Sep 17 00:00:00 2001
From: Tristan Sloughter
Date: Thu, 4 May 2017 20:43:42 -0700
Subject: add binary string support to http_uri functions
---
lib/inets/doc/src/http_uri.xml | 19 ++++++++++---------
1 file changed, 10 insertions(+), 9 deletions(-)
(limited to 'lib/inets/doc/src')
diff --git a/lib/inets/doc/src/http_uri.xml b/lib/inets/doc/src/http_uri.xml
index 696b7dfa31..acf0d2163a 100644
--- a/lib/inets/doc/src/http_uri.xml
+++ b/lib/inets/doc/src/http_uri.xml
@@ -45,6 +45,7 @@
this module:
boolean() = true | false
string() = list of ASCII characters
+ unicode_binary() = binary() with characters encoded in the UTF-8 coding standard
@@ -53,22 +54,22 @@
Type definitions that are related to URI:
- uri() = string()
+ uri() = string() | unicode:unicode_binary()
Syntax according to the URI definition in RFC 3986,
for example, "http://www.erlang.org/"
- user_info() = string()
+ user_info() = string() | unicode:unicode_binary()
scheme() = atom()
Example: http, https
- host() = string()
+ host() = string() | unicode:unicode_binary()
port() = pos_integer()
- path() = string()
+ path() = string() | unicode:unicode_binary()
Represents a file path or directory path
- query() = string()
+ query() = string() | unicode:unicode_binary()
- fragment() = string()
+ fragment() = string() | unicode:unicode_binary()
@@ -83,7 +84,7 @@
Decodes a hexadecimal encoded URI.
- HexEncodedURI = string() - A possibly hexadecimal encoded URI
+ HexEncodedURI = string() | unicode:unicode_binary() - A possibly hexadecimal encoded URI
URI = uri()
@@ -98,7 +99,7 @@
Encodes a hexadecimal encoded URI.
URI = uri()
- HexEncodedURI = string() - Hexadecimal encoded URI
+ HexEncodedURI = string() | unicode:unicode_binary() - Hexadecimal encoded URI
@@ -145,7 +146,7 @@
Scheme validation fun is to be defined as follows:
-fun(SchemeStr :: string()) ->
+fun(SchemeStr :: string() | unicode:unicode_binary()) ->
valid | {error, Reason :: term()}.
--
cgit v1.2.3