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.

3 lines
3.5 KiB

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>InferStdlib__Escape (InferStdlib.InferStdlib__Escape)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> &mdash; <span class="package">package <a href="../index.html">InferStdlib</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">InferStdlib__Escape</span></h1></header><p>Escape a string for use in a CSV or XML file: replace reserved
characters with escape sequences</p><div class="spec val" id="val-escape_dotty"><a href="#val-escape_dotty" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>escape_dotty : string <span class="keyword">&#8209;&gt;</span> string</code></div><div class="doc"><p>escape a string to be used in a dotty file</p></div></div><div class="spec val" id="val-escape_csv"><a href="#val-escape_csv" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>escape_csv : string <span class="keyword">&#8209;&gt;</span> string</code></div><div class="doc"><p>escape a string to be used in a csv file</p></div></div><div class="spec val" id="val-escape_path"><a href="#val-escape_path" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>escape_path : string <span class="keyword">&#8209;&gt;</span> string</code></div><div class="doc"><p>escape a path replacing the directory separator with an underscore</p></div></div><div class="spec val" id="val-escape_xml"><a href="#val-escape_xml" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>escape_xml : string <span class="keyword">&#8209;&gt;</span> string</code></div><div class="doc"><p>escape a string to be used in an xml file</p></div></div><div class="spec val" id="val-escape_url"><a href="#val-escape_url" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>escape_url : string <span class="keyword">&#8209;&gt;</span> string</code></div><div class="doc"></div></div><div class="spec val" id="val-escape_filename"><a href="#val-escape_filename" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>escape_filename : string <span class="keyword">&#8209;&gt;</span> string</code></div><div class="doc"><p>escape a string to be used as a file name</p></div></div><div class="spec val" id="val-escape_double_quotes"><a href="#val-escape_double_quotes" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>escape_double_quotes : string <span class="keyword">&#8209;&gt;</span> string</code></div><div class="doc"><p>replaces double-quote with backslash double-quote</p></div></div><div class="spec val" id="val-escape_in_single_quotes"><a href="#val-escape_in_single_quotes" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>escape_in_single_quotes : string <span class="keyword">&#8209;&gt;</span> string</code></div><div class="doc"><p>put the string inside single quotes and escape the single quotes within that string</p></div></div><div class="spec val" id="val-escape_shell"><a href="#val-escape_shell" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>escape_shell : string <span class="keyword">&#8209;&gt;</span> string</code></div><div class="doc"><p>escape the string so it can be passed to the shell without remorse</p></div></div></body></html>