From a42858f00ba09759d5f723895e52cd89c77165ac Mon Sep 17 00:00:00 2001
From: Tristan Sloughter <t@crashfast.com>
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')

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:</p>
     <p><c>boolean() = true | false</c></p>
     <p><c>string()</c> = list of ASCII characters</p>
+    <p><c>unicode_binary()</c> = binary() with characters encoded in the UTF-8 coding standard</p>
 
   </section>
   
@@ -53,22 +54,22 @@
     <p>Type definitions that are related to URI:</p>
     
 <taglist>
-       <tag><c>uri() = string()</c></tag>
+       <tag><c>uri() = string() | unicode:unicode_binary()</c></tag>
        <item><p>Syntax according to the URI definition in RFC 3986,
        for example, "http://www.erlang.org/"</p></item>
-       <tag><c>user_info() = string()</c></tag>
+       <tag><c>user_info() = string() | unicode:unicode_binary()</c></tag>
        <item><p></p></item>
        <tag><c>scheme() = atom()</c></tag>
        <item><p>Example: http, https</p></item>
-       <tag><c>host() = string()</c></tag>
+       <tag><c>host() = string() | unicode:unicode_binary()</c></tag>
        <item><p></p></item>
        <tag><c>port() = pos_integer()</c></tag>
        <item><p></p></item>
-       <tag><c>path() = string()</c></tag>
+       <tag><c>path() = string() | unicode:unicode_binary()</c></tag>
        <item><p>Represents a file path or directory path</p></item>
-       <tag><c>query() = string()</c></tag>
+       <tag><c>query() = string() | unicode:unicode_binary()</c></tag>
        <item><p></p></item>
-       <tag><c>fragment() = string()</c></tag>
+       <tag><c>fragment() = string() | unicode:unicode_binary()</c></tag>
        <item><p></p></item>
      </taglist>
    
@@ -83,7 +84,7 @@
       
       <fsummary>Decodes a hexadecimal encoded URI.</fsummary>
       <type>
-        <v>HexEncodedURI = string() - A possibly hexadecimal encoded URI</v>
+        <v>HexEncodedURI = string() | unicode:unicode_binary() - A possibly hexadecimal encoded URI</v>
         <v>URI = uri()</v>
       </type>
 
@@ -98,7 +99,7 @@
       <fsummary>Encodes a hexadecimal encoded URI.</fsummary>
       <type>
         <v>URI = uri()</v>
-        <v>HexEncodedURI = string() - Hexadecimal encoded URI</v>
+        <v>HexEncodedURI = string() | unicode:unicode_binary() - Hexadecimal encoded URI</v>
       </type>
 
       <desc>
@@ -145,7 +146,7 @@
         <p>Scheme validation fun is to be defined as follows:</p>
 
 	<code>
-fun(SchemeStr :: string()) ->
+fun(SchemeStr :: string() | unicode:unicode_binary()) ->
 	valid |	{error, Reason :: term()}.
 	</code>
 
-- 
cgit v1.2.3