This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.
<!DOCTYPE html>
<htmlxmlns="http://www.w3.org/1999/xhtml"><head><title>Escape (infer.IStdlib.Escape)</title><linkrel="stylesheet"href="../../../odoc.css"/><metacharset="utf-8"/><metaname="generator"content="odoc 1.5.2"/><metaname="viewport"content="width=device-width,initial-scale=1.0"/><scriptsrc="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><divclass="content"><header><nav><ahref="../index.html">Up</a>–<ahref="../../index.html">infer</a>»<ahref="../index.html">IStdlib</a>» Escape</nav><h1>Module <code>IStdlib.Escape</code></h1></header><aside><p>Escape a string, eg replace reserved characters with escape sequences</p></aside><dl><dtclass="spec value"id="val-escape_dotty"><ahref="#val-escape_dotty"class="anchor"></a><code><spanclass="keyword">val</span> escape_dotty : string <span>-></span> string</code></dt><dd><p>escape a string to be used in a dotty file</p></dd></dl><dl><dtclass="spec value"id="val-escape_path"><ahref="#val-escape_path"class="anchor"></a><code><spanclass="keyword">val</span> escape_path : string <span>-></span> string</code></dt><dd><p>escape a path replacing the directory separator with an underscore</p></dd></dl><dl><dtclass="spec value"id="val-escape_xml"><ahref="#val-escape_xml"class="anchor"></a><code><spanclass="keyword">val</span> escape_xml : string <span>-></span> string</code></dt><dd><p>escape a string to be used in an xml file</p></dd></dl><dl><dtclass="spec value"id="val-escape_url"><ahref="#val-escape_url"class="anchor"></a><code><spanclass="keyword">val</span> escape_url : string <span>-></span> string</code></dt><dtclass="spec value"id="val-escape_json"><ahref="#val-escape_json"class="anchor"></a><code><spanclass="keyword">val</span> escape_json : string <span>-></span> string</code></dt><dd><p>escape characters in the string so it becomes a valid JSON string</p></dd></dl><dl><dtclass="spec value"id="val-escape_double_quotes"><ahref="#val-escape_double_quotes"class="anchor"></a><code><spanclass="keyword">val</span> escape_double_quotes : string <span>-></span> string</code></dt><dd><p>replaces double-quote with backslash double-quote</p></dd></dl><dl><dtclass="spec value"id="val-escape_in_single_quotes"><ahref="#val-escape_in_single_quotes"class="anchor"></a><code><spanclass="keyword">val</span> escape_in_single_quotes : string <span>-></span> string</code></dt><dd><p>put the string inside single quotes and escape the single quotes within that string</p></dd></dl><dl><dtclass="spec value"id="val-escape_shell"><ahref="#val-escape_shell"class="anchor"></a><code><spanclass="keyword">val</span> escape_shell : string <span>-></span> string</code></dt><dd><p>escape the string so it can be passed to the shell without remorse</p></dd></dl></div></body></html>