dollars.html 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>system/dollars</title>
  9. <!-- Google fonts -->
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  11. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  12. <!-- Favicon -->
  13. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
  14. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
  15. <!-- CSS -->
  16. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
  17. <!-- JS -->
  18. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
  19. </head>
  20. <body>
  21. <div class="document" id="documentId">
  22. <div class="container">
  23. <h1 class="title">system/dollars</h1>
  24. <div class="row">
  25. <div class="three columns">
  26. <div class="theme-select-wrapper">
  27. <label for="theme-select">Theme:&nbsp;</label>
  28. <select id="theme-select" onchange="setTheme(this.value)">
  29. <option value="auto">🌗 Match OS</option>
  30. <option value="dark">🌑 Dark</option>
  31. <option value="light">🌕 Light</option>
  32. </select>
  33. </div>
  34. <div id="global-links">
  35. <ul class="simple-boot">
  36. <li><a href="manual.html">Manual</a></li>
  37. <li><a href="lib.html">Standard library</a></li>
  38. <li> <a id="indexLink" href="theindex.html">Index</a></li>
  39. <li><a href="compiler/theindex.html">Compiler docs</a></li>
  40. <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
  41. <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
  42. </ul>
  43. </div>
  44. <div id="searchInputDiv">
  45. Search: <input type="search" id="searchInput"
  46. oninput="search()" />
  47. </div>
  48. <ul class="simple simple-toc" id="toc-list">
  49. <li>
  50. <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
  51. </li>
  52. <li>
  53. <details open>
  54. <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
  55. <ul class="simple simple-toc-section">
  56. <ul class="simple nested-toc-section">$
  57. <li><a class="reference" href="#%24%2Ctypedesc" title="`$`(t: typedesc): string">`$`(t: typedesc): string</a></li>
  58. <li><a class="reference" href="#%24%2Cbool" title="`$`(x: bool): string">`$`(x: bool): string</a></li>
  59. <li><a class="reference" href="#%24%2Cchar" title="`$`(x: char): string">`$`(x: char): string</a></li>
  60. <li><a class="reference" href="#%24%2Ccstring" title="`$`(x: cstring): string">`$`(x: cstring): string</a></li>
  61. <li><a class="reference" href="#%24%2Cint" title="`$`(x: int): string">`$`(x: int): string</a></li>
  62. <li><a class="reference" href="#%24%2Cint64" title="`$`(x: int64): string">`$`(x: int64): string</a></li>
  63. <li><a class="reference" href="#%24%2Cstring" title="`$`(x: string): string">`$`(x: string): string</a></li>
  64. <li><a class="reference" href="#%24%2Cuint64" title="`$`(x: uint64): string">`$`(x: uint64): string</a></li>
  65. <li><a class="reference" href="#%24" title="`$`(x`gensym0: `{}`(int, lit)): string">`$`(x`gensym0: `{}`(int, lit)): string</a></li>
  66. <li><a class="reference" href="#%24_2" title="`$`(x`gensym1: `{}`(uint64, lit)): string">`$`(x`gensym1: `{}`(uint64, lit)): string</a></li>
  67. <li><a class="reference" href="#%24_3" title="`$`(x`gensym2: `{}`(int64, lit)): string">`$`(x`gensym2: `{}`(int64, lit)): string</a></li>
  68. <li><a class="reference" href="#%24%2CEnum" title="`$`[Enum: enum](x: Enum): string">`$`[Enum: enum](x: Enum): string</a></li>
  69. <li><a class="reference" href="#%24%2Carray%5BIDX%2CT%5D" title="`$`[T, IDX](x: array[IDX, T]): string">`$`[T, IDX](x: array[IDX, T]): string</a></li>
  70. <li><a class="reference" href="#%24%2CHSlice%5BT%2CU%5D" title="`$`[T, U](x: HSlice[T, U]): string">`$`[T, U](x: HSlice[T, U]): string</a></li>
  71. <li><a class="reference" href="#%24%2CT" title="`$`[T: tuple](x: T): string">`$`[T: tuple](x: T): string</a></li>
  72. <li><a class="reference" href="#%24%2CopenArray%5BT%5D" title="`$`[T](x: openArray[T]): string">`$`[T](x: openArray[T]): string</a></li>
  73. <li><a class="reference" href="#%24%2Cseq%5BT%5D" title="`$`[T](x: seq[T]): string">`$`[T](x: seq[T]): string</a></li>
  74. <li><a class="reference" href="#%24%2Cset%5BT%5D" title="`$`[T](x: set[T]): string">`$`[T](x: set[T]): string</a></li>
  75. </ul>
  76. </ul>
  77. </details>
  78. </li>
  79. </ul>
  80. </div>
  81. <div class="nine columns" id="content">
  82. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  83. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  84. <div id="tocRoot"></div>
  85. <p class="module-desc"><tt class="docutils literal"><span class="pre"><span class="Operator">$</span></span></tt> is Nim's general way of spelling <span id="tostring_1">toString</span>.
  86. <p><strong class="examples_text">Example:</strong></p>
  87. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">system</span><span class="Operator">/</span><span class="Identifier">dollars</span>
  88. <span class="Identifier">assert</span> <span class="Operator">$</span><span class="FloatNumber">0.1</span> <span class="Operator">==</span> <span class="StringLit">&quot;0.1&quot;</span>
  89. <span class="Identifier">assert</span> <span class="Operator">$</span><span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">2</span><span class="Operator">*</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;-6&quot;</span></pre></p>
  90. <div class="section" id="6">
  91. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  92. <dl class="item">
  93. <a class="reference external" href="digitsutils.html">digitsutils</a>, <a class="reference external" href="miscdollars.html">miscdollars</a>
  94. </dl>
  95. </div>
  96. <div class="section" id="12">
  97. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  98. <dl class="item">
  99. <div id="$-procs-all">
  100. <div id="$,typedesc">
  101. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2Ctypedesc"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;TypeTrait&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  102. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  103. <dd>
  104. <p>Returns the name of the given type.</p>
  105. <p>For more procedures dealing with <tt class="docutils literal"><span class="pre"><span class="Identifier">typedesc</span></span></tt>, see <a class="reference external" href="typetraits.html">typetraits module</a>.</p>
  106. <p><pre class="listing"><span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Punctuation">(</span><span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="DecNumber">42</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;int&quot;</span>
  107. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Punctuation">(</span><span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="StringLit">&quot;Foo&quot;</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;string&quot;</span>
  108. <span class="Keyword">static</span><span class="Punctuation">:</span> <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Punctuation">(</span><span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">'</span><span class="Identifier">A</span><span class="CharLit">', '</span><span class="Identifier">B</span><span class="CharLit">'])) == &quot;seq[char]&quot;</span></pre></p>
  109. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L70" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  110. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L70" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  111. </dd>
  112. </div>
  113. <div id="$,bool">
  114. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2Cbool"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;BoolToStr&quot;</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  115. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  116. <dd>
  117. The stringify operator for a boolean argument. Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> converted to the string &quot;false&quot; or &quot;true&quot;.
  118. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L43" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  119. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L43" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  120. </dd>
  121. </div>
  122. <div id="$,char">
  123. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2Cchar"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;CharToStr&quot;</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  124. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  125. <dd>
  126. <p>The stringify operator for a character argument. Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> converted to a string.</p>
  127. <p><pre class="listing"><span class="Identifier">assert</span> <span class="Operator">$</span><span class="CharLit">'c'</span> <span class="Operator">==</span> <span class="StringLit">&quot;c&quot;</span></pre></p>
  128. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L47" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  129. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L47" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  130. </dd>
  131. </div>
  132. <div id="$,cstring">
  133. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2Ccstring"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;CStrToStr&quot;</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  134. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  135. <dd>
  136. The stringify operator for a CString argument. Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> converted to a string.
  137. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L54" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  138. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L54" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  139. </dd>
  140. </div>
  141. <div id="$,int">
  142. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2Cint"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  143. <dd>
  144. Outplace version of <tt class="docutils literal"><span class="pre"><span class="Identifier">addInt</span></span></tt>.
  145. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L17" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  146. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L17" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  147. </dd>
  148. </div>
  149. <div id="$,int64">
  150. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2Cint64"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  151. <dd>
  152. Outplace version of <tt class="docutils literal"><span class="pre"><span class="Identifier">addInt</span></span></tt>.
  153. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L22" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  154. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L22" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  155. </dd>
  156. </div>
  157. <div id="$,string">
  158. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2Cstring"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;StrToStr&quot;</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  159. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  160. <dd>
  161. The stringify operator for a string argument. Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> as it is. This operator is useful for generic code, so that <tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="Identifier">expr</span></span></tt> also works if <tt class="docutils literal"><span class="pre"><span class="Identifier">expr</span></span></tt> is already a string.
  162. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L58" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  163. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L58" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  164. </dd>
  165. </div>
  166. <div id="$,uint64">
  167. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2Cuint64"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  168. <dd>
  169. Outplace version of <tt class="docutils literal"><span class="pre"><span class="Identifier">addInt</span></span></tt>.
  170. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L27" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  171. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L27" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  172. </dd>
  173. </div>
  174. <div id="$">
  175. <dt><pre><span class="Keyword">func</span> <a href="#%24"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">x`gensym0</span><span class="Other">:</span> <span class="Other">`</span><span class="Operator">{}</span><span class="Other">`</span><span class="Other">(</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <span class="Identifier">lit</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">compileTime</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  176. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  177. <dd>
  178. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L38" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  179. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L38" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  180. </dd>
  181. </div>
  182. <div id="$_2">
  183. <dt><pre><span class="Keyword">func</span> <a href="#%24_2"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">x`gensym1</span><span class="Other">:</span> <span class="Other">`</span><span class="Operator">{}</span><span class="Other">`</span><span class="Other">(</span><a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">,</span> <span class="Identifier">lit</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">compileTime</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  184. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  185. <dd>
  186. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L39" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  187. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L39" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  188. </dd>
  189. </div>
  190. <div id="$_3">
  191. <dt><pre><span class="Keyword">func</span> <a href="#%24_3"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">x`gensym2</span><span class="Other">:</span> <span class="Other">`</span><span class="Operator">{}</span><span class="Other">`</span><span class="Other">(</span><a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">,</span> <span class="Identifier">lit</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">compileTime</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  192. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  193. <dd>
  194. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L40" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  195. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L40" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  196. </dd>
  197. </div>
  198. <div id="$,Enum">
  199. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CEnum"><span class="Identifier">`$`</span></a><span class="Other">[</span><span class="Identifier">Enum</span><span class="Other">:</span> <span class="Keyword">enum</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">Enum</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;EnumToStr&quot;</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
  200. <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  201. <dd>
  202. <p>The stringify operator for an enumeration argument. This works for any enumeration type thanks to compiler magic.</p>
  203. <p>If a <tt class="docutils literal"><span class="pre"><span class="Operator">$</span></span></tt> operator for a concrete enumeration is provided, this is used instead. (In other words: <em>Overwriting</em> is possible.)</p>
  204. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L63" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  205. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L63" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  206. </dd>
  207. </div>
  208. <div id="$,array[IDX,T]">
  209. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2Carray%5BIDX%2CT%5D"><span class="Identifier">`$`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">IDX</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">IDX</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
  210. <dd>
  211. Generic <tt class="docutils literal"><span class="pre"><span class="Operator">$</span></span></tt> operator for arrays that is lifted from the components.
  212. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L143" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  213. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L143" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  214. </dd>
  215. </div>
  216. <div id="$,HSlice[T,U]">
  217. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CHSlice%5BT%2CU%5D"><span class="Identifier">`$`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">U</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">U</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
  218. <dd>
  219. <p>Generic <tt class="docutils literal"><span class="pre"><span class="Operator">$</span></span></tt> operator for slices that is lifted from the components of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. Example:</p>
  220. <p><pre class="listing"><span class="Operator">$</span><span class="Punctuation">(</span><span class="DecNumber">1</span> <span class="Operator">..</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;1 .. 5&quot;</span></pre></p>
  221. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L131" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  222. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L131" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  223. </dd>
  224. </div>
  225. <div id="$,T">
  226. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CT"><span class="Identifier">`$`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
  227. <dd>
  228. <p>Generic <tt class="docutils literal"><span class="pre"><span class="Operator">$</span></span></tt> operator for tuples that is lifted from the components of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. Example:</p>
  229. <p><pre class="listing"><span class="Operator">$</span><span class="Punctuation">(</span><span class="DecNumber">23</span><span class="Punctuation">,</span> <span class="DecNumber">45</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;(23, 45)&quot;</span>
  230. <span class="Operator">$</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">:</span> <span class="DecNumber">23</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">:</span> <span class="DecNumber">45</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;(a: 23, b: 45)&quot;</span>
  231. <span class="Operator">$</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;()&quot;</span></pre></p>
  232. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L82" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  233. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L82" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  234. </dd>
  235. </div>
  236. <div id="$,openArray[T]">
  237. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CopenArray%5BT%5D"><span class="Identifier">`$`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
  238. <dd>
  239. <p>Generic <tt class="docutils literal"><span class="pre"><span class="Operator">$</span></span></tt> operator for openarrays that is lifted from the components of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. Example:</p>
  240. <p><pre class="listing"><span class="Operator">$</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">23</span><span class="Punctuation">,</span> <span class="DecNumber">45</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">toOpenArray</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;[23, 45]&quot;</span></pre></p>
  241. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L147" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  242. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L147" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  243. </dd>
  244. </div>
  245. <div id="$,seq[T]">
  246. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2Cseq%5BT%5D"><span class="Identifier">`$`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
  247. <dd>
  248. <p>Generic <tt class="docutils literal"><span class="pre"><span class="Operator">$</span></span></tt> operator for seqs that is lifted from the components of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. Example:</p>
  249. <p><pre class="listing"><span class="Operator">$</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">23</span><span class="Punctuation">,</span> <span class="DecNumber">45</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;@[23, 45]&quot;</span></pre></p>
  250. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L123" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  251. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L123" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  252. </dd>
  253. </div>
  254. <div id="$,set[T]">
  255. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2Cset%5BT%5D"><span class="Identifier">`$`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
  256. <dd>
  257. <p>Generic <tt class="docutils literal"><span class="pre"><span class="Operator">$</span></span></tt> operator for sets that is lifted from the components of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. Example:</p>
  258. <p><pre class="listing"><span class="Operator">$</span><span class="Punctuation">{</span><span class="DecNumber">23</span><span class="Punctuation">,</span> <span class="DecNumber">45</span><span class="Punctuation">}</span> <span class="Operator">==</span> <span class="StringLit">&quot;{23, 45}&quot;</span></pre></p>
  259. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/dollars.nim#L115" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  260. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/dollars.nim#L115" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  261. </dd>
  262. </div>
  263. </div>
  264. </dl>
  265. </div>
  266. </div>
  267. </div>
  268. <div class="twelve-columns footer">
  269. <span class="nim-sprite"></span>
  270. <br>
  271. <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-03 14:57:19 UTC</small>
  272. </div>
  273. </div>
  274. </div>
  275. <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
  276. </body>
  277. </html>