diff options
author | Péter Dimitrov <[email protected]> | 2017-11-06 09:54:12 +0100 |
---|---|---|
committer | Péter Dimitrov <[email protected]> | 2017-11-06 14:39:45 +0100 |
commit | 7e5d062973e7cb4f9ee949529e9dcdb5785c1304 (patch) | |
tree | ca2fc1717791c2beddd7aa8a3c70e3fecacdba0e /lib/stdlib/doc/src | |
parent | 74c2a9db0caa376ea375614fcc67c3a9295737d7 (diff) | |
download | otp-7e5d062973e7cb4f9ee949529e9dcdb5785c1304.tar.gz otp-7e5d062973e7cb4f9ee949529e9dcdb5785c1304.tar.bz2 otp-7e5d062973e7cb4f9ee949529e9dcdb5785c1304.zip |
stdlib: Remove compose_query and dissect_query
compose_query/{1,2} and dissect_query/1 removed as the implemented
specification (HTML 2.0) is old. They will be re-implemented based
on HTML5.
Diffstat (limited to 'lib/stdlib/doc/src')
-rw-r--r-- | lib/stdlib/doc/src/uri_string.xml | 87 |
1 files changed, 1 insertions, 86 deletions
diff --git a/lib/stdlib/doc/src/uri_string.xml b/lib/stdlib/doc/src/uri_string.xml index 8fa2a92370..9ace2b0a05 100644 --- a/lib/stdlib/doc/src/uri_string.xml +++ b/lib/stdlib/doc/src/uri_string.xml @@ -31,8 +31,7 @@ <modulesummary>URI processing functions.</modulesummary> <description> <p>This module contains functions for parsing and handling URIs - (<url href="https://www.ietf.org/rfc/rfc3986.txt">RFC 3986</url>) and - form-urlencoded query strings (<url href="https://www.ietf.org/rfc/rfc1866.txt">RFC 1866</url>). + (<url href="https://www.ietf.org/rfc/rfc3986.txt">RFC 3986</url>). </p> <p>A URI is an identifier consisting of a sequence of characters matching the syntax rule named <em>URI</em> in <url href="https://www.ietf.org/rfc/rfc3986.txt">RFC 3986</url>. @@ -72,13 +71,6 @@ <item>Transforming URIs into a normalized form<br></br> <seealso marker="#normalize/1"><c>normalize/1</c></seealso> </item> - <item>Composing form-urlencoded query strings from a list of key-value pairs<br></br> - <seealso marker="#compose_query/1"><c>compose_query/1</c></seealso><br></br> - <seealso marker="#compose_query/2"><c>compose_query/2</c></seealso> - </item> - <item>Dissecting form-urlencoded query strings into a list of key-value pairs<br></br> - <seealso marker="#dissect_query/1"><c>dissect_query/1</c></seealso> - </item> </list> <p>There are four different encodings present during the handling of URIs:</p> <list type="bulleted"> @@ -110,14 +102,12 @@ <desc> <p>Error tuple indicating the type of error. Possible values of the second component:</p> <list type="bulleted"> - <item><c>invalid_character</c></item> <item><c>invalid_input</c></item> <item><c>invalid_map</c></item> <item><c>invalid_percent_encoding</c></item> <item><c>invalid_scheme</c></item> <item><c>invalid_uri</c></item> <item><c>invalid_utf8</c></item> - <item><c>missing_value</c></item> </list> <p>The third component is a term providing additional information about the cause of the error.</p> @@ -144,81 +134,6 @@ <funcs> <func> - <name name="compose_query" arity="1"/> - <fsummary>Compose urlencoded query string.</fsummary> - <desc> - <p>Composes a form-urlencoded <c><anno>QueryString</anno></c> based on a - <c><anno>QueryList</anno></c>, a list of non-percent-encoded key-value pairs. - Form-urlencoding is defined in section - 8.2.1 of <url href="https://www.ietf.org/rfc/rfc1866.txt">RFC 1866</url> - (HTML 2.0) for media type <c>application/x-www-form-urlencoded</c>. - Reserved and unsafe characters, as - defined by <url href="https://www.ietf.org/rfc/rfc1738.txt">RFC 1738</url> - (Uniform Resource Locators), are percent-encoded.</p> - <p>See also the opposite operation <seealso marker="#dissect_query/1"> - <c>dissect_query/1</c></seealso>. - </p> - <p><em>Example:</em></p> - <pre> -1> <input>uri_string:compose_query([{"foo bar","1"},{"city","örebro"}]).</input> -<![CDATA["foo+bar=1&city=%C3%B6rebro"]]> -2> <![CDATA[uri_string:compose_query([{<<"foo bar">>,<<"1">>}, -2> {<<"city">>,<<"örebro"/utf8>>}]).]]> -<![CDATA[<<"foo+bar=1&city=%C3%B6rebro">>]]> - </pre> - </desc> - </func> - - <func> - <name name="compose_query" arity="2"/> - <fsummary>Compose urlencoded query string.</fsummary> - <desc> - <p>Same as <c>compose_query/1</c> but with an additional - <c><anno>Options</anno></c> parameter, that controls the type of separator used - between key-value pairs. There are three supported separator types: <c>amp</c> (<![CDATA[&]]>), <c>escaped_amp</c> (<![CDATA[&]]>) and <c>semicolon</c> (;). If the parameter <c><anno>Options</anno></c> is empty, separator takes the default value (<c>escaped_amp</c>).</p> - <p>See also the opposite operation <seealso marker="#dissect_query/1"> - <c>dissect_query/1</c></seealso>. - </p> - <p><em>Example:</em></p> - <pre> -1> <input>uri_string:compose_query([{"foo bar","1"},{"city","örebro"}],</input> -1> [{separator, amp}]). -<![CDATA["foo+bar=1&city=%C3%B6rebro" -2> uri_string:compose_query([{<<"foo bar">>,<<"1">>}, -2> {<<"city">>,<<"örebro"/utf8>>}], [{separator, escaped_amp}]).]]> -<![CDATA[<<"foo+bar=1&city=%C3%B6rebro">>]]> - </pre> - </desc> - </func> - - <func> - <name name="dissect_query" arity="1"/> - <fsummary>Dissect query string.</fsummary> - <desc> - <p>Dissects an urlencoded <c><anno>QueryString</anno></c> and returns a - <c><anno>QueryList</anno></c>, a list of non-percent-encoded key-value pairs. - Form-urlencoding is defined in section - 8.2.1 of <url href="https://www.ietf.org/rfc/rfc1866.txt">RFC 1866</url> - (HTML 2.0) for media type <c>application/x-www-form-urlencoded</c>. - Percent-encoded segments are decoded as defined by - <url href="https://www.ietf.org/rfc/rfc1738.txt">RFC 1738</url> - (Uniform Resource Locators).</p> - <p>Supported separator types: <c>amp</c> (<![CDATA[&]]>), <c>escaped_amp</c> - (<![CDATA[&]]>) and <c>semicolon</c> (;).</p> - <p>See also the opposite operation <seealso marker="#compose_query/1"> - <c>compose_query/1</c></seealso>. - </p> - <p><em>Example:</em></p> - <pre> -1> <input>uri_string:dissect_query("foo+bar=1;city=%C3%B6rebro").</input> -[{"foo bar","1"},{"city","örebro"}] -2> <![CDATA[uri_string:dissect_query(<<"foo+bar=1&city=%C3%B6rebro">>).]]> -<![CDATA[[{<<"foo bar">>,<<"1">>},{<<"city">>,<<"örebro"/utf8>>}] ]]> - </pre> - </desc> - </func> - - <func> <name name="normalize" arity="1"/> <fsummary>Syntax-based normalization.</fsummary> <desc> |