You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2 lines
2.9 KiB

This file contains ambiguous Unicode characters!

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>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Escape (infer.IStdlib.Escape)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">infer</a> &#x00BB; <a href="../index.html">IStdlib</a> &#x00BB; 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><dt class="spec value" id="val-escape_dotty"><a href="#val-escape_dotty" class="anchor"></a><code><span class="keyword">val</span> escape_dotty : string <span>&#45;&gt;</span> string</code></dt><dd><p>escape a string to be used in a dotty file</p></dd></dl><dl><dt class="spec value" id="val-escape_path"><a href="#val-escape_path" class="anchor"></a><code><span class="keyword">val</span> escape_path : string <span>&#45;&gt;</span> string</code></dt><dd><p>escape a path replacing the directory separator with an underscore</p></dd></dl><dl><dt class="spec value" id="val-escape_xml"><a href="#val-escape_xml" class="anchor"></a><code><span class="keyword">val</span> escape_xml : string <span>&#45;&gt;</span> string</code></dt><dd><p>escape a string to be used in an xml file</p></dd></dl><dl><dt class="spec value" id="val-escape_url"><a href="#val-escape_url" class="anchor"></a><code><span class="keyword">val</span> escape_url : string <span>&#45;&gt;</span> string</code></dt><dt class="spec value" id="val-escape_json"><a href="#val-escape_json" class="anchor"></a><code><span class="keyword">val</span> escape_json : string <span>&#45;&gt;</span> string</code></dt><dd><p>escape characters in the string so it becomes a valid JSON string</p></dd></dl><dl><dt class="spec value" id="val-escape_double_quotes"><a href="#val-escape_double_quotes" class="anchor"></a><code><span class="keyword">val</span> escape_double_quotes : string <span>&#45;&gt;</span> string</code></dt><dd><p>replaces double-quote with backslash double-quote</p></dd></dl><dl><dt class="spec value" id="val-escape_in_single_quotes"><a href="#val-escape_in_single_quotes" class="anchor"></a><code><span class="keyword">val</span> escape_in_single_quotes : string <span>&#45;&gt;</span> string</code></dt><dd><p>put the string inside single quotes and escape the single quotes within that string</p></dd></dl><dl><dt class="spec value" id="val-escape_shell"><a href="#val-escape_shell" class="anchor"></a><code><span class="keyword">val</span> escape_shell : string <span>&#45;&gt;</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>