Inicio Explorar Ayuda
Iniciar sesión
levovix
/
Nim
espejo de https://github.com/nim-lang/Nim
Seguir 1
Destacar 0
Fork 1
Archivos Incidencias 0 Wiki
Rama: gh-pages
Ramas Etiquetas
Nim
/
logging.html

logging.html 103 KB
Permalink Histórico Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024 
  1. <?xml version="1.0" encoding="utf-8" ?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <!--  This file is generated by Nim. -->
    4. 

  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
    5. 

  5. <head>
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    8. 

  8. <title>std/logging</title>
    9. 

  9. 

  10. <!-- Google fonts -->
    11. 

  11. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
    12. 

  12. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
    13. 

  13. 

  14. <!-- Favicon -->
    15. 

  15. <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=="/>
    16. 

  16. <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=">
    17. 

  17. 

  18. <!-- CSS -->
    19. 

  19. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
    20. 

  20. 

  21. <!-- JS -->
    22. 

  22. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
    23. 

  23. </head>
    24. 

  24. <body>
    25. 

  25.   <div class="document" id="documentId">
    26. 

  26.     <div class="container">
    27. 

  27.       <h1 class="title">std/logging</h1>
    28. 

  28.       <div class="row">
    29. 

  29.   <div class="three columns">
    30. 

  30.     <div class="theme-select-wrapper">
    31. 

  31.       <label for="theme-select">Theme:&nbsp;</label>
    32. 

  32.       <select id="theme-select" onchange="setTheme(this.value)">
    33. 

  33.         <option value="auto">🌗 Match OS</option>
    34. 

  34.         <option value="dark">🌑 Dark</option>
    35. 

  35.         <option value="light">🌕 Light</option>
    36. 

  36.       </select>
    37. 

  37.     </div>
    38. 

  38.     <div id="global-links">
    39. 

  39.       <ul class="simple-boot">
    40. 

  40.         <li><a href="manual.html">Manual</a></li>
    41. 

  41.         <li><a href="lib.html">Standard library</a></li>
    42. 

  42.         <li> <a id="indexLink" href="theindex.html">Index</a></li>
    43. 

  43.         <li><a href="compiler/theindex.html">Compiler docs</a></li>
    44. 

  44.         <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
    45. 

  45.         <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
    46. 

  46.       </ul>
    47. 

  47.     </div>
    48. 

  48.     <div id="searchInputDiv">
    49. 

  49.       Search: <input type="search" id="searchInput"
    50. 

  50.         oninput="search()" />
    51. 

  51.     </div>
    52. 

  52.     
    53. 

  53.     <ul class="simple simple-toc" id="toc-list">
    54. 

  54.   <li><a class="reference" id="basic-usage_toc" href="#basic-usage">Basic usage</a></li>
    55. 

  55. <ul class="simple"><li><a class="reference" id="basic-usage-handlers_toc" href="#basic-usage-handlers">Handlers</a></li>
    56. 

  56. <li><a class="reference" id="basic-usage-format-strings_toc" href="#basic-usage-format-strings">Format strings</a></li>
    57. 

  57. <li><a class="reference" id="basic-usage-notes-when-using-multiple-threads_toc" href="#basic-usage-notes-when-using-multiple-threads">Notes when using multiple threads</a></li>
    58. 

  58. </ul><li><a class="reference" id="see-also_toc" href="#see-also">See also</a></li>
    59. 

  59. <li>
    60. 

  60.   <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
    61. 

  61. </li>
    62. 

  62. <li>
    63. 

  63.   <details open>
    64. 

  64.     <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    65. 

  65.     <ul class="simple simple-toc-section">
    66. 

  66.       <li><a class="reference" href="#ConsoleLogger" title="ConsoleLogger = ref object of Logger
    67. 

  67.   useStderr*: bool           ## If true, writes to stderr; otherwise, writes to stdout
    68. 

  68.   flushThreshold*: Level     ## Only messages that are at or above this
    69. 

  69.                              ## threshold will be flushed immediately">ConsoleLogger</a></li>
    70. 

  70. <li><a class="reference" href="#FileLogger" title="FileLogger = ref object of Logger
    71. 

  71.   file*: File                ## The wrapped file
    72. 

  72.   flushThreshold*: Level     ## Only messages that are at or above this
    73. 

  73.                              ## threshold will be flushed immediately">FileLogger</a></li>
    74. 

  74. <li><a class="reference" href="#Level" title="Level = enum
    75. 

  75.   lvlAll,                   ## All levels active
    76. 

  76.   lvlDebug,                 ## Debug level and above are active
    77. 

  77.   lvlInfo,                  ## Info level and above are active
    78. 

  78.   lvlNotice,                ## Notice level and above are active
    79. 

  79.   lvlWarn,                  ## Warn level and above are active
    80. 

  80.   lvlError,                 ## Error level and above are active
    81. 

  81.   lvlFatal,                 ## Fatal level and above are active
    82. 

  82.   lvlNone                    ## No levels active; nothing is logged">Level</a></li>
    83. 

  83. <li><a class="reference" href="#Logger" title="Logger = ref object of RootObj
    84. 

  84.   levelThreshold*: Level     ## Only messages that are at or above this
    85. 

  85.                              ## threshold will be logged
    86. 

  86.   fmtStr*: string            ## Format string to prepend to each log message;
    87. 

  87.                              ## defaultFmtStr is the default">Logger</a></li>
    88. 

  88. <li><a class="reference" href="#RollingFileLogger" title="RollingFileLogger = ref object of FileLogger">RollingFileLogger</a></li>
    89. 

  89. 

  90.     </ul>
    91. 

  91.   </details>
    92. 

  92. </li>
    93. 

  93. <li>
    94. 

  94.   <details open>
    95. 

  95.     <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
    96. 

  96.     <ul class="simple simple-toc-section">
    97. 

  97.       <li><a class="reference" href="#defaultFmtStr" title="defaultFmtStr = &quot;$levelname &quot;">defaultFmtStr</a></li>
    98. 

  98. <li><a class="reference" href="#LevelNames" title="LevelNames: array[Level, string] = [&quot;DEBUG&quot;, &quot;DEBUG&quot;, &quot;INFO&quot;, &quot;NOTICE&quot;, &quot;WARN&quot;,
    99. 

  99.                                     &quot;ERROR&quot;, &quot;FATAL&quot;, &quot;NONE&quot;]">LevelNames</a></li>
    100. 

  100. <li><a class="reference" href="#verboseFmtStr" title="verboseFmtStr = &quot;$levelid, [$datetime] -- $appname: &quot;">verboseFmtStr</a></li>
    101. 

  101. 

  102.     </ul>
    103. 

  103.   </details>
    104. 

  104. </li>
    105. 

  105. <li>
    106. 

  106.   <details open>
    107. 

  107.     <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    108. 

  108.     <ul class="simple simple-toc-section">
    109. 

  109.       <ul class="simple nested-toc-section">addHandler
    110. 

  110.   <li><a class="reference" href="#addHandler%2CLogger" title="addHandler(handler: Logger)">addHandler(handler: Logger)</a></li>
    111. 

  111. 

  112. </ul>
    113. 

  113. <ul class="simple nested-toc-section">defaultFilename
    114. 

  114.   <li><a class="reference" href="#defaultFilename" title="defaultFilename(): string">defaultFilename(): string</a></li>
    115. 

  115. 

  116. </ul>
    117. 

  117. <ul class="simple nested-toc-section">getHandlers
    118. 

  118.   <li><a class="reference" href="#getHandlers" title="getHandlers(): seq[Logger]">getHandlers(): seq[Logger]</a></li>
    119. 

  119. 

  120. </ul>
    121. 

  121. <ul class="simple nested-toc-section">getLogFilter
    122. 

  122.   <li><a class="reference" href="#getLogFilter" title="getLogFilter(): Level">getLogFilter(): Level</a></li>
    123. 

  123. 

  124. </ul>
    125. 

  125. <ul class="simple nested-toc-section">newConsoleLogger
    126. 

  126.   <li><a class="reference" href="#newConsoleLogger" title="newConsoleLogger(levelThreshold = lvlAll; fmtStr = defaultFmtStr;
    127. 

  127.                  useStderr = false; flushThreshold = defaultFlushThreshold): ConsoleLogger">newConsoleLogger(levelThreshold = lvlAll; fmtStr = defaultFmtStr;
    128. 

  128.                  useStderr = false; flushThreshold = defaultFlushThreshold): ConsoleLogger</a></li>
    129. 

  129. 

  130. </ul>
    131. 

  131. <ul class="simple nested-toc-section">newFileLogger
    132. 

  132.   <li><a class="reference" href="#newFileLogger%2CFile" title="newFileLogger(file: File; levelThreshold = lvlAll; fmtStr = defaultFmtStr;
    133. 

  133.               flushThreshold = defaultFlushThreshold): FileLogger">newFileLogger(file: File; levelThreshold = lvlAll; fmtStr = defaultFmtStr;
    134. 

  134.               flushThreshold = defaultFlushThreshold): FileLogger</a></li>
    135. 

  135. <li><a class="reference" href="#newFileLogger%2CFileMode%2Cint" title="newFileLogger(filename = defaultFilename(); mode: FileMode = fmAppend;
    136. 

  136.               levelThreshold = lvlAll; fmtStr = defaultFmtStr;
    137. 

  137.               bufSize: int = -1; flushThreshold = defaultFlushThreshold): FileLogger">newFileLogger(filename = defaultFilename(); mode: FileMode = fmAppend;
    138. 

  138.               levelThreshold = lvlAll; fmtStr = defaultFmtStr;
    139. 

  139.               bufSize: int = -1; flushThreshold = defaultFlushThreshold): FileLogger</a></li>
    140. 

  140. 

  141. </ul>
    142. 

  142. <ul class="simple nested-toc-section">newRollingFileLogger
    143. 

  143.   <li><a class="reference" href="#newRollingFileLogger%2CFileMode%2CPositive%2Cint" title="newRollingFileLogger(filename = defaultFilename(); mode: FileMode = fmReadWrite;
    144. 

  144.                      levelThreshold = lvlAll; fmtStr = defaultFmtStr;
    145. 

  145.                      maxLines: Positive = 1000; bufSize: int = -1;
    146. 

  146.                      flushThreshold = defaultFlushThreshold): RollingFileLogger">newRollingFileLogger(filename = defaultFilename(); mode: FileMode = fmReadWrite;
    147. 

  147.                      levelThreshold = lvlAll; fmtStr = defaultFmtStr;
    148. 

  148.                      maxLines: Positive = 1000; bufSize: int = -1;
    149. 

  149.                      flushThreshold = defaultFlushThreshold): RollingFileLogger</a></li>
    150. 

  150. 

  151. </ul>
    152. 

  152. <ul class="simple nested-toc-section">removeHandler
    153. 

  153.   <li><a class="reference" href="#removeHandler%2CLogger" title="removeHandler(handler: Logger)">removeHandler(handler: Logger)</a></li>
    154. 

  154. 

  155. </ul>
    156. 

  156. <ul class="simple nested-toc-section">setLogFilter
    157. 

  157.   <li><a class="reference" href="#setLogFilter%2CLevel" title="setLogFilter(lvl: Level)">setLogFilter(lvl: Level)</a></li>
    158. 

  158. 

  159. </ul>
    160. 

  160. <ul class="simple nested-toc-section">substituteLog
    161. 

  161.   <li><a class="reference" href="#substituteLog%2Cstring%2CLevel%2Cvarargs%5Bstring%2C%5D" title="substituteLog(frmt: string; level: Level; args: varargs[string, `$`]): string">substituteLog(frmt: string; level: Level; args: varargs[string, `$`]): string</a></li>
    162. 

  162. 

  163. </ul>
    164. 

  164. 

  165.     </ul>
    166. 

  166.   </details>
    167. 

  167. </li>
    168. 

  168. <li>
    169. 

  169.   <details open>
    170. 

  170.     <summary><a class="reference reference-toplevel" href="#14" id="64">Methods</a></summary>
    171. 

  171.     <ul class="simple simple-toc-section">
    172. 

  172.       <ul class="simple nested-toc-section">log
    173. 

  173.   <li><a class="reference" href="#log.e%2CConsoleLogger%2CLevel%2Cvarargs%5Bstring%2C%5D" title="log(logger: ConsoleLogger; level: Level; args: varargs[string, `$`])">log(logger: ConsoleLogger; level: Level; args: varargs[string, `$`])</a></li>
    174. 

  174. <li><a class="reference" href="#log.e%2CFileLogger%2CLevel%2Cvarargs%5Bstring%2C%5D" title="log(logger: FileLogger; level: Level; args: varargs[string, `$`])">log(logger: FileLogger; level: Level; args: varargs[string, `$`])</a></li>
    175. 

  175. <li><a class="reference" href="#log.e%2CLogger%2CLevel%2Cvarargs%5Bstring%2C%5D" title="log(logger: Logger; level: Level; args: varargs[string, `$`])">log(logger: Logger; level: Level; args: varargs[string, `$`])</a></li>
    176. 

  176. <li><a class="reference" href="#log.e%2CRollingFileLogger%2CLevel%2Cvarargs%5Bstring%2C%5D" title="log(logger: RollingFileLogger; level: Level; args: varargs[string, `$`])">log(logger: RollingFileLogger; level: Level; args: varargs[string, `$`])</a></li>
    177. 

  177. 

  178. </ul>
    179. 

  179. 

  180.     </ul>
    181. 

  181.   </details>
    182. 

  182. </li>
    183. 

  183. <li>
    184. 

  184.   <details open>
    185. 

  185.     <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
    186. 

  186.     <ul class="simple simple-toc-section">
    187. 

  187.       <ul class="simple nested-toc-section">debug
    188. 

  188.   <li><a class="reference" href="#debug.t%2Cvarargs%5Bstring%2C%5D" title="debug(args: varargs[string, `$`])">debug(args: varargs[string, `$`])</a></li>
    189. 

  189. 

  190. </ul>
    191. 

  191. <ul class="simple nested-toc-section">error
    192. 

  192.   <li><a class="reference" href="#error.t%2Cvarargs%5Bstring%2C%5D" title="error(args: varargs[string, `$`])">error(args: varargs[string, `$`])</a></li>
    193. 

  193. 

  194. </ul>
    195. 

  195. <ul class="simple nested-toc-section">fatal
    196. 

  196.   <li><a class="reference" href="#fatal.t%2Cvarargs%5Bstring%2C%5D" title="fatal(args: varargs[string, `$`])">fatal(args: varargs[string, `$`])</a></li>
    197. 

  197. 

  198. </ul>
    199. 

  199. <ul class="simple nested-toc-section">info
    200. 

  200.   <li><a class="reference" href="#info.t%2Cvarargs%5Bstring%2C%5D" title="info(args: varargs[string, `$`])">info(args: varargs[string, `$`])</a></li>
    201. 

  201. 

  202. </ul>
    203. 

  203. <ul class="simple nested-toc-section">log
    204. 

  204.   <li><a class="reference" href="#log.t%2CLevel%2Cvarargs%5Bstring%2C%5D" title="log(level: Level; args: varargs[string, `$`])">log(level: Level; args: varargs[string, `$`])</a></li>
    205. 

  205. 

  206. </ul>
    207. 

  207. <ul class="simple nested-toc-section">notice
    208. 

  208.   <li><a class="reference" href="#notice.t%2Cvarargs%5Bstring%2C%5D" title="notice(args: varargs[string, `$`])">notice(args: varargs[string, `$`])</a></li>
    209. 

  209. 

  210. </ul>
    211. 

  211. <ul class="simple nested-toc-section">warn
    212. 

  212.   <li><a class="reference" href="#warn.t%2Cvarargs%5Bstring%2C%5D" title="warn(args: varargs[string, `$`])">warn(args: varargs[string, `$`])</a></li>
    213. 

  213. 

  214. </ul>
    215. 

  215. 

  216.     </ul>
    217. 

  217.   </details>
    218. 

  218. </li>
    219. 

  219. 

  220. </ul>
    221. 

  221. 

  222.   </div>
    223. 

  223.   <div class="nine columns" id="content">
    224. 

  224.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    225. 

  225. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    226. 

  226. 

  227.     <div id="tocRoot"></div>
    228. 

  228.     
    229. 

  229.     <p class="module-desc"><p>This module implements a simple logger.</p>
    230. 

  230. <p>It has been designed to be as simple as possible to avoid bloat. If this library does not fulfill your needs, write your own.</p>
    231. 

  231. 

  232. <h1><a class="toc-backref" id="basic-usage" href="#basic-usage">Basic usage</a></h1><p>To get started, first create a logger:</p>
    233. 

  233. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">logging</span>
    234. 

  234. 

  235. <span class="Keyword">var</span> <span class="Identifier">logger</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    236. 

  236. <p>The logger that was created above logs to the console, but this module also provides loggers that log to files, such as the <a class="reference external" href="#FileLogger">FileLogger</a>. Creating custom loggers is also possible by inheriting from the <a class="reference external" href="#Logger">Logger</a> type.</p>
    237. 

  237. <p>Once a logger has been created, call its <a class="reference external" href="#log.e,ConsoleLogger,Level,varargs[string,]">log proc</a> to log a message:</p>
    238. 

  238. <p><pre class="listing"><span class="Identifier">logger</span><span class="Operator">.</span><span class="Identifier">log</span><span class="Punctuation">(</span><span class="Identifier">lvlInfo</span><span class="Punctuation">,</span> <span class="StringLit">&quot;a log message&quot;</span><span class="Punctuation">)</span>
    239. 

  239. <span class="Comment"># Output: INFO a log message</span></pre></p>
    240. 

  240. <p>The <tt class="docutils literal"><span class="pre">INFO</span></tt> within the output is the result of a format string being prepended to the message, and it will differ depending on the message's level. Format strings are <a class="reference external" href="#basic-usage-format-strings">explained in more detail here</a>.</p>
    241. 

  241. <p>There are six logging levels: debug, info, notice, warn, error, and fatal. They are described in more detail within the <a class="reference external" href="#Level">Level enum's documentation</a>. A message is logged if its level is at or above both the logger's <tt class="docutils literal"><span class="pre">levelThreshold</span></tt> field and the global log filter. The latter can be changed with the <a class="reference external" href="#setLogFilter,Level">setLogFilter proc</a>.</p>
    242. 

  242. <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    243. 

  243. For loggers that log to a console or to files, only error and fatal messages will cause their output buffers to be flushed immediately by default. set <tt class="docutils literal"><span class="pre">flushThreshold</span></tt> when creating the logger to change this.</div>
    244. 

  244. 

  245. <h2><a class="toc-backref" id="basic-usage-handlers" href="#basic-usage-handlers">Handlers</a></h2><p>When using multiple loggers, calling the log proc for each logger can become repetitive. Instead of doing that, register each logger that will be used with the <a class="reference external" href="#addHandler,Logger">addHandler proc</a>, which is demonstrated in the following example:</p>
    246. 

  246. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">logging</span>
    247. 

  247. 

  248. <span class="Keyword">var</span> <span class="Identifier">consoleLog</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    249. 

  249. <span class="Keyword">var</span> <span class="Identifier">fileLog</span> <span class="Operator">=</span> <span class="Identifier">newFileLogger</span><span class="Punctuation">(</span><span class="StringLit">&quot;errors.log&quot;</span><span class="Punctuation">,</span> <span class="Identifier">levelThreshold</span><span class="Operator">=</span><span class="Identifier">lvlError</span><span class="Punctuation">)</span>
    250. 

  250. <span class="Keyword">var</span> <span class="Identifier">rollingLog</span> <span class="Operator">=</span> <span class="Identifier">newRollingFileLogger</span><span class="Punctuation">(</span><span class="StringLit">&quot;rolling.log&quot;</span><span class="Punctuation">)</span>
    251. 

  251. 

  252. <span class="Identifier">addHandler</span><span class="Punctuation">(</span><span class="Identifier">consoleLog</span><span class="Punctuation">)</span>
    253. 

  253. <span class="Identifier">addHandler</span><span class="Punctuation">(</span><span class="Identifier">fileLog</span><span class="Punctuation">)</span>
    254. 

  254. <span class="Identifier">addHandler</span><span class="Punctuation">(</span><span class="Identifier">rollingLog</span><span class="Punctuation">)</span></pre></p>
    255. 

  255. <p>After doing this, use either the <a class="reference external" href="#log.t,Level,varargs[string,]">log template</a> or one of the level-specific templates, such as the <a class="reference external" href="#error.t,varargs[string,]">error template</a>, to log messages to all registered handlers at once.</p>
    256. 

  256. <p><pre class="listing"><span class="Comment"># This example uses the loggers created above</span>
    257. 

  257. <span class="Identifier">log</span><span class="Punctuation">(</span><span class="Identifier">lvlError</span><span class="Punctuation">,</span> <span class="StringLit">&quot;an error occurred&quot;</span><span class="Punctuation">)</span>
    258. 

  258. <span class="Identifier">error</span><span class="Punctuation">(</span><span class="StringLit">&quot;an error occurred&quot;</span><span class="Punctuation">)</span>  <span class="Comment"># Equivalent to the above line</span>
    259. 

  259. <span class="Identifier">info</span><span class="Punctuation">(</span><span class="StringLit">&quot;something normal happened&quot;</span><span class="Punctuation">)</span>  <span class="Comment"># Will not be written to errors.log</span></pre></p>
    260. 

  260. <p>Note that a message's level is still checked against each handler's <tt class="docutils literal"><span class="pre">levelThreshold</span></tt> and the global log filter.</p>
    261. 

  261. 

  262. <h2><a class="toc-backref" id="basic-usage-format-strings" href="#basic-usage-format-strings">Format strings</a></h2><p>Log messages are prefixed with format strings. These strings contain placeholders for variables, such as <tt class="docutils literal"><span class="pre">$time</span></tt>, that are replaced with their corresponding values, such as the current time, before they are prepended to a log message. Characters that are not part of variables are unaffected.</p>
    263. 

  263. <p>The format string used by a logger can be specified by providing the <tt class="docutils literal"><span class="pre"><span class="Identifier">fmtStr</span></span></tt> argument when creating the logger or by setting its <tt class="docutils literal"><span class="pre"><span class="Identifier">fmtStr</span></span></tt> field afterward. If not specified, the <a class="reference external" href="#defaultFmtStr">default format string</a> is used.</p>
    264. 

  264. <p>The following variables, which must be prefixed with a dollar sign (<tt class="docutils literal"><span class="pre">$</span></tt>), are available:</p>
    265. 

  265. <table border="1" class="docutils"><tr><th>Variable</th><th>Output</th></tr>
    266. 

  266. <tr><td>$date</td><td>Current date</td></tr>
    267. 

  267. <tr><td>$time</td><td>Current time</td></tr>
    268. 

  268. <tr><td>$datetime</td><td>$dateT$time</td></tr>
    269. 

  269. <tr><td>$app</td><td><a class="reference external" href="os.html#getAppFilename">os.getAppFilename()</a></td></tr>
    270. 

  270. <tr><td>$appname</td><td>Base name of <tt class="docutils literal"><span class="pre">$app</span></tt></td></tr>
    271. 

  271. <tr><td>$appdir</td><td>Directory name of <tt class="docutils literal"><span class="pre">$app</span></tt></td></tr>
    272. 

  272. <tr><td>$levelid</td><td>First letter of log level</td></tr>
    273. 

  273. <tr><td>$levelname</td><td>Log level name</td></tr>
    274. 

  274. </table><p>Note that <tt class="docutils literal"><span class="pre">$app</span></tt>, <tt class="docutils literal"><span class="pre">$appname</span></tt>, and <tt class="docutils literal"><span class="pre">$appdir</span></tt> are not supported when using the JavaScript backend.</p>
    275. 

  275. <p>The following example illustrates how to use format strings:</p>
    276. 

  276. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">logging</span>
    277. 

  277. 

  278. <span class="Keyword">var</span> <span class="Identifier">logger</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Identifier">fmtStr</span><span class="Operator">=</span><span class="StringLit">&quot;[$time] - $levelname: &quot;</span><span class="Punctuation">)</span>
    279. 

  279. <span class="Identifier">logger</span><span class="Operator">.</span><span class="Identifier">log</span><span class="Punctuation">(</span><span class="Identifier">lvlInfo</span><span class="Punctuation">,</span> <span class="StringLit">&quot;this is a message&quot;</span><span class="Punctuation">)</span>
    280. 

  280. <span class="Comment"># Output: [19:50:13] - INFO: this is a message</span></pre></p>
    281. 

  281. 

  282. <h2><a class="toc-backref" id="basic-usage-notes-when-using-multiple-threads" href="#basic-usage-notes-when-using-multiple-threads">Notes when using multiple threads</a></h2><p>There are a few details to keep in mind when using this module within multiple threads:</p>
    283. 

  283. <ul class="simple"><li>The global log filter is actually a thread-local variable, so it needs to be set in each thread that uses this module.</li>
    284. 

  284. <li>The list of registered handlers is also a thread-local variable. If a handler will be used in multiple threads, it needs to be registered in each of those threads.</li>
    285. 

  285. </ul>
    286. 

  286. 

  287. <h1><a class="toc-backref" id="see-also" href="#see-also">See also</a></h1><ul class="simple"><li><a class="reference external" href="strutils.html">strutils module</a> for common string functions</li>
    288. 

  288. <li><a class="reference external" href="strformat.html">strformat module</a> for string interpolation and formatting</li>
    289. 

  289. <li><a class="reference external" href="strscans.html">strscans module</a> for <tt class="docutils literal"><span class="pre">scanf</span></tt> and <tt class="docutils literal"><span class="pre">scanp</span></tt> macros, which offer easier substring extraction than regular expressions</li>
    290. 

  290. </ul>
    291. 

  291. </p>
    292. 

  292.     <div class="section" id="6">
    293. 

  293.   <h1><a class="toc-backref" href="#6">Imports</a></h1>
    294. 

  294.   <dl class="item">
    295. 

  295.     <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="times.html">times</a>, <a class="reference external" href="os.html">os</a>, <a class="reference external" href="syncio.html">syncio</a>
    296. 

  296.   </dl>
    297. 

  297. </div>
    298. 

  298. <div class="section" id="7">
    299. 

  299.   <h1><a class="toc-backref" href="#7">Types</a></h1>
    300. 

  300.   <dl class="item">
    301. 

  301.     <div id="ConsoleLogger">
    302. 

  302.   <dt><pre><a href="logging.html#ConsoleLogger"><span class="Identifier">ConsoleLogger</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="logging.html#Logger"><span class="Identifier">Logger</span></a>
    303. 

  303.   <span class="Identifier">useStderr</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a>           <span class="Comment">## If true, writes to stderr; otherwise, writes to stdout</span>
    304. 

  304.   <span class="Identifier">flushThreshold</span><span class="Operator">*</span><span class="Other">:</span> <a href="logging.html#Level"><span class="Identifier">Level</span></a>     <span class="Comment">## Only messages that are at or above this</span>
    305. 

  305.                              <span class="Comment">## threshold will be flushed immediately</span></pre></dt>
    306. 

  306.   <dd>
    307. 

  307.     
    308. 

  308.     <p>A logger that writes log messages to the console.</p>
    309. 

  309. <p>Create a new <tt class="docutils literal"><span class="pre">ConsoleLogger</span></tt> with the <a class="reference external" href="#newConsoleLogger">newConsoleLogger proc</a>.</p>
    310. 

  310. <p>See also:</p>
    311. 

  311. <ul class="simple"><li><a class="reference external" href="#FileLogger">FileLogger</a></li>
    312. 

  312. <li><a class="reference external" href="#RollingFileLogger">RollingFileLogger</a></li>
    313. 

  313. </ul>
    314. 

  314. 

  315.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L234" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    316. 

  316. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L234" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    317. 

  317. 

  318.   </dd>
    319. 

  319. </div>
    320. 

  320. <div id="FileLogger">
    321. 

  321.   <dt><pre><a href="logging.html#FileLogger"><span class="Identifier">FileLogger</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="logging.html#Logger"><span class="Identifier">Logger</span></a>
    322. 

  322.   <span class="Identifier">file</span><span class="Operator">*</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a>                <span class="Comment">## The wrapped file</span>
    323. 

  323.   <span class="Identifier">flushThreshold</span><span class="Operator">*</span><span class="Other">:</span> <a href="logging.html#Level"><span class="Identifier">Level</span></a>     <span class="Comment">## Only messages that are at or above this</span>
    324. 

  324.                              <span class="Comment">## threshold will be flushed immediately</span></pre></dt>
    325. 

  325.   <dd>
    326. 

  326.     
    327. 

  327.     <p>A logger that writes log messages to a file.</p>
    328. 

  328. <p>Create a new <tt class="docutils literal"><span class="pre">FileLogger</span></tt> with the <a class="reference external" href="#newFileLogger,File">newFileLogger proc</a>.</p>
    329. 

  329. <p><strong>Note:</strong> This logger is not available for the JavaScript backend.</p>
    330. 

  330. <p>See also:</p>
    331. 

  331. <ul class="simple"><li><a class="reference external" href="#ConsoleLogger">ConsoleLogger</a></li>
    332. 

  332. <li><a class="reference external" href="#RollingFileLogger">RollingFileLogger</a></li>
    333. 

  333. </ul>
    334. 

  334. 

  335.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L249" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    336. 

  336. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L249" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    337. 

  337. 

  338.   </dd>
    339. 

  339. </div>
    340. 

  340. <div id="Level">
    341. 

  341.   <dt><pre><a href="logging.html#Level"><span class="Identifier">Level</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    342. 

  342.   <span class="Identifier">lvlAll</span><span class="Other">,</span>                   <span class="Comment">## All levels active</span>
    343. 

  343.   <span class="Identifier">lvlDebug</span><span class="Other">,</span>                 <span class="Comment">## Debug level and above are active</span>
    344. 

  344.   <span class="Identifier">lvlInfo</span><span class="Other">,</span>                  <span class="Comment">## Info level and above are active</span>
    345. 

  345.   <span class="Identifier">lvlNotice</span><span class="Other">,</span>                <span class="Comment">## Notice level and above are active</span>
    346. 

  346.   <span class="Identifier">lvlWarn</span><span class="Other">,</span>                  <span class="Comment">## Warn level and above are active</span>
    347. 

  347.   <span class="Identifier">lvlError</span><span class="Other">,</span>                 <span class="Comment">## Error level and above are active</span>
    348. 

  348.   <span class="Identifier">lvlFatal</span><span class="Other">,</span>                 <span class="Comment">## Fatal level and above are active</span>
    349. 

  349.   <span class="Identifier">lvlNone</span>                    <span class="Comment">## No levels active; nothing is logged</span></pre></dt>
    350. 

  350.   <dd>
    351. 

  351.     
    352. 

  352.     <p>
    353. 

  353. Enumeration of logging levels.</p>
    354. 

  354. <p>Debug messages represent the lowest logging level, and fatal error messages represent the highest logging level. <tt class="docutils literal"><span class="pre">lvlAll</span></tt> can be used to enable all messages, while <tt class="docutils literal"><span class="pre">lvlNone</span></tt> can be used to disable all messages.</p>
    355. 

  355. <p>Typical usage for each logging level, from lowest to highest, is described below:</p>
    356. 

  356. <ul class="simple"><li><strong>Debug</strong> - debugging information helpful only to developers</li>
    357. 

  357. <li><strong>Info</strong> - anything associated with normal operation and without any particular importance</li>
    358. 

  358. <li><strong>Notice</strong> - more important information that users should be notified about</li>
    359. 

  359. <li><strong>Warn</strong> - impending problems that require some attention</li>
    360. 

  360. <li><strong>Error</strong> - error conditions that the application can recover from</li>
    361. 

  361. <li><strong>Fatal</strong> - fatal errors that prevent the application from continuing</li>
    362. 

  362. </ul>
    363. 

  363. <p>It is completely up to the application how to utilize each level.</p>
    364. 

  364. <p>Individual loggers have a <tt class="docutils literal"><span class="pre">levelThreshold</span></tt> field that filters out any messages with a level lower than the threshold. There is also a global filter that applies to all log messages, and it can be changed using the <a class="reference external" href="#setLogFilter,Level">setLogFilter proc</a>.</p>
    365. 

  365. 

  366.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L157" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    367. 

  367. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L157" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    368. 

  368. 

  369.   </dd>
    370. 

  370. </div>
    371. 

  371. <div id="Logger">
    372. 

  372.   <dt><pre><a href="logging.html#Logger"><span class="Identifier">Logger</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a>
    373. 

  373.   <span class="Identifier">levelThreshold</span><span class="Operator">*</span><span class="Other">:</span> <a href="logging.html#Level"><span class="Identifier">Level</span></a>     <span class="Comment">## Only messages that are at or above this</span>
    374. 

  374.                              <span class="Comment">## threshold will be logged</span>
    375. 

  375.   <span class="Identifier">fmtStr</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>            <span class="Comment">## Format string to prepend to each log message;</span>
    376. 

  376.                              <span class="Comment">## defaultFmtStr is the default</span></pre></dt>
    377. 

  377.   <dd>
    378. 

  378.     
    379. 

  379.     <p>The abstract base type of all loggers.</p>
    380. 

  380. <p>Custom loggers should inherit from this type. They should also provide their own implementation of the <a class="reference external" href="#log.e,Logger,Level,varargs[string,]">log method</a>.</p>
    381. 

  381. <p>See also:</p>
    382. 

  382. <ul class="simple"><li><a class="reference external" href="#ConsoleLogger">ConsoleLogger</a></li>
    383. 

  383. <li><a class="reference external" href="#FileLogger">FileLogger</a></li>
    384. 

  384. <li><a class="reference external" href="#RollingFileLogger">RollingFileLogger</a></li>
    385. 

  385. </ul>
    386. 

  386. 

  387.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L218" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    388. 

  388. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L218" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    389. 

  389. 

  390.   </dd>
    391. 

  391. </div>
    392. 

  392. <div id="RollingFileLogger">
    393. 

  393.   <dt><pre><a href="logging.html#RollingFileLogger"><span class="Identifier">RollingFileLogger</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="logging.html#FileLogger"><span class="Identifier">FileLogger</span></a></pre></dt>
    394. 

  394.   <dd>
    395. 

  395.     
    396. 

  396.     <p>A logger that writes log messages to a file while performing log rotation.</p>
    397. 

  397. <p>Create a new <tt class="docutils literal"><span class="pre">RollingFileLogger</span></tt> with the <a class="reference external" href="#newRollingFileLogger,FileMode,Positive,int">newRollingFileLogger proc</a>.</p>
    398. 

  398. <p><strong>Note:</strong> This logger is not available for the JavaScript backend.</p>
    399. 

  399. <p>See also:</p>
    400. 

  400. <ul class="simple"><li><a class="reference external" href="#ConsoleLogger">ConsoleLogger</a></li>
    401. 

  401. <li><a class="reference external" href="#FileLogger">FileLogger</a></li>
    402. 

  402. </ul>
    403. 

  403. 

  404.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L264" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    405. 

  405. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L264" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    406. 

  406. 

  407.   </dd>
    408. 

  408. </div>
    409. 

  409. 

  410.   </dl>
    411. 

  411. </div>
    412. 

  412. <div class="section" id="10">
    413. 

  413.   <h1><a class="toc-backref" href="#10">Consts</a></h1>
    414. 

  414.   <dl class="item">
    415. 

  415.     <div id="defaultFmtStr">
    416. 

  416.   <dt><pre><a href="logging.html#defaultFmtStr"><span class="Identifier">defaultFmtStr</span></a> <span class="Other">=</span> <span class="StringLit">&quot;$levelname &quot;</span></pre></dt>
    417. 

  417.   <dd>
    418. 

  418.     
    419. 

  419.     The default format string.
    420. 

  420.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L197" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    421. 

  421. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L197" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    422. 

  422. 

  423.   </dd>
    424. 

  424. </div>
    425. 

  425. <div id="LevelNames">
    426. 

  426.   <dt><pre><a href="logging.html#LevelNames"><span class="Identifier">LevelNames</span></a><span class="Other">:</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">Level</span><span class="Other">,</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Other">[</span><span class="StringLit">&quot;DEBUG&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;DEBUG&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;INFO&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;NOTICE&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;WARN&quot;</span><span class="Other">,</span>
    427. 

  427.                                     <span class="StringLit">&quot;ERROR&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;FATAL&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;NONE&quot;</span><span class="Other">]</span></pre></dt>
    428. 

  428.   <dd>
    429. 

  429.     
    430. 

  430.     Array of strings representing each logging level.
    431. 

  431.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L193" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    432. 

  432. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L193" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    433. 

  433. 

  434.   </dd>
    435. 

  435. </div>
    436. 

  436. <div id="verboseFmtStr">
    437. 

  437.   <dt><pre><a href="logging.html#verboseFmtStr"><span class="Identifier">verboseFmtStr</span></a> <span class="Other">=</span> <span class="StringLit">&quot;$levelid, [$datetime] -- $appname: &quot;</span></pre></dt>
    438. 

  438.   <dd>
    439. 

  439.     
    440. 

  440.     <p>
    441. 

  441. A more verbose format string.</p>
    442. 

  442. <p>This string can be passed as the <tt class="docutils literal"><span class="pre">frmStr</span></tt> argument to procs that create new loggers, such as the <a class="reference external" href="#newConsoleLogger">newConsoleLogger proc</a>.</p>
    443. 

  443. <p>If a different format string is preferred, refer to the <a class="reference external" href="#basic-usage-format-strings">documentation about format strings</a> for more information, including a list of available variables.</p>
    444. 

  444. 

  445.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L198" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    446. 

  446. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L198" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    447. 

  447. 

  448.   </dd>
    449. 

  449. </div>
    450. 

  450. 

  451.   </dl>
    452. 

  452. </div>
    453. 

  453. <div class="section" id="12">
    454. 

  454.   <h1><a class="toc-backref" href="#12">Procs</a></h1>
    455. 

  455.   <dl class="item">
    456. 

  456.     <div id="addHandler-procs-all">
    457. 

  457.   <div id="addHandler,Logger">
    458. 

  458.   <dt><pre><span class="Keyword">proc</span> <a href="#addHandler%2CLogger"><span class="Identifier">addHandler</span></a><span class="Other">(</span><span class="Identifier">handler</span><span class="Other">:</span> <a href="logging.html#Logger"><span class="Identifier">Logger</span></a><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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    459. 

  459.   <dd>
    460. 

  460.     
    461. 

  461.     Adds a logger to the list of registered handlers.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    462. 

  462. The list of handlers is a thread-local variable. If the given handler will be used in multiple threads, this proc should be called in each of those threads.</div>
    463. 

  463. <p>See also:</p>
    464. 

  464. <ul class="simple"><li><a class="reference internal nimdoc" title="proc removeHandler(handler: Logger)" href="#removeHandler,Logger">removeHandler proc</a></li>
    465. 

  465. <li><a class="reference external" href="#getHandlers">getHandlers proc</a></li>
    466. 

  466. </ul>
    467. 

  467. 

  468. <p><strong class="examples_text">Example:</strong></p>
    469. 

  469. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">logger</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    470. 

  470. <span class="Identifier">addHandler</span><span class="Punctuation">(</span><span class="Identifier">logger</span><span class="Punctuation">)</span>
    471. 

  471. <span class="Identifier">doAssert</span> <span class="Identifier">logger</span> <span class="Keyword">in</span> <span class="Identifier">getHandlers</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    472. 

  472.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L835" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    473. 

  473. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L835" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    474. 

  474. 

  475.   </dd>
    476. 

  476. </div>
    477. 

  477. 

  478. </div>
    479. 

  479. <div id="defaultFilename-procs-all">
    480. 

  480.   <div id="defaultFilename">
    481. 

  481.   <dt><pre><span class="Keyword">proc</span> <a href="#defaultFilename"><span class="Identifier">defaultFilename</span></a><span class="Other">(</span><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="Identifier">ReadIOEffect</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>
    482. 

  482.   <dd>
    483. 

  483.     
    484. 

  484.     <p>Returns the filename that is used by default when naming log files.</p>
    485. 

  485. <p><strong>Note:</strong> This proc is not available for the JavaScript backend.</p>
    486. 

  486. 

  487.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L469" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    488. 

  488. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L469" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    489. 

  489. 

  490.   </dd>
    491. 

  491. </div>
    492. 

  492. 

  493. </div>
    494. 

  494. <div id="getHandlers-procs-all">
    495. 

  495.   <div id="getHandlers">
    496. 

  496.   <dt><pre><span class="Keyword">proc</span> <a href="#getHandlers"><span class="Identifier">getHandlers</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="logging.html#Logger"><span class="Identifier">Logger</span></a><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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    497. 

  497.   <dd>
    498. 

  498.     
    499. 

  499.     <p>Returns a list of all the registered handlers.</p>
    500. 

  500. <p>See also:</p>
    501. 

  501. <ul class="simple"><li><a class="reference external" href="#addHandler,Logger">addHandler proc</a></li>
    502. 

  502. </ul>
    503. 

  503. 

  504.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L861" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    505. 

  505. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L861" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    506. 

  506. 

  507.   </dd>
    508. 

  508. </div>
    509. 

  509. 

  510. </div>
    511. 

  511. <div id="getLogFilter-procs-all">
    512. 

  512.   <div id="getLogFilter">
    513. 

  513.   <dt><pre><span class="Keyword">proc</span> <a href="#getLogFilter"><span class="Identifier">getLogFilter</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="logging.html#Level"><span class="Identifier">Level</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>
    514. 

  514.   <dd>
    515. 

  515.     
    516. 

  516.     <p>Gets the global log filter.</p>
    517. 

  517. <p>See also:</p>
    518. 

  518. <ul class="simple"><li><a class="reference external" href="#setLogFilter,Level">setLogFilter proc</a></li>
    519. 

  519. </ul>
    520. 

  520. 

  521.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L887" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    522. 

  522. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L887" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    523. 

  523. 

  524.   </dd>
    525. 

  525. </div>
    526. 

  526. 

  527. </div>
    528. 

  528. <div id="newConsoleLogger-procs-all">
    529. 

  529.   <div id="newConsoleLogger">
    530. 

  530.   <dt><pre><span class="Keyword">proc</span> <a href="#newConsoleLogger"><span class="Identifier">newConsoleLogger</span></a><span class="Other">(</span><span class="Identifier">levelThreshold</span> <span class="Other">=</span> <span class="Identifier">lvlAll</span><span class="Other">;</span> <span class="Identifier">fmtStr</span> <span class="Other">=</span> <span class="Identifier">defaultFmtStr</span><span class="Other">;</span>
    531. 

  531.                       <span class="Identifier">useStderr</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">flushThreshold</span> <span class="Other">=</span> <span class="Identifier">defaultFlushThreshold</span><span class="Other">)</span><span class="Other">:</span> <a href="logging.html#ConsoleLogger"><span class="Identifier">ConsoleLogger</span></a> {.
    532. 

  532.     <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>
    533. 

  533.   <dd>
    534. 

  534.     
    535. 

  535.     <p>Creates a new <a class="reference external" href="#ConsoleLogger">ConsoleLogger</a>.</p>
    536. 

  536. <p>By default, log messages are written to <tt class="docutils literal"><span class="pre">stdout</span></tt>. If <tt class="docutils literal"><span class="pre">useStderr</span></tt> is true, they are written to <tt class="docutils literal"><span class="pre">stderr</span></tt> instead.</p>
    537. 

  537. <p>For the JavaScript backend, log messages are written to the console, and <tt class="docutils literal"><span class="pre">useStderr</span></tt> is ignored.</p>
    538. 

  538. <p>See also:</p>
    539. 

  539. <ul class="simple"><li><a class="reference external" href="#newFileLogger,File">newFileLogger proc</a> that uses a file handle</li>
    540. 

  540. <li><a class="reference external" href="#newFileLogger,FileMode,int">newFileLogger proc</a> that accepts a filename</li>
    541. 

  541. <li><a class="reference external" href="#newRollingFileLogger,FileMode,Positive,int">newRollingFileLogger proc</a></li>
    542. 

  542. </ul>
    543. 

  543. <p><strong>Examples:</strong></p>
    544. 

  544. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">normalLog</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    545. 

  545. <span class="Keyword">var</span> <span class="Identifier">formatLog</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Identifier">fmtStr</span><span class="Operator">=</span><span class="Identifier">verboseFmtStr</span><span class="Punctuation">)</span>
    546. 

  546. <span class="Keyword">var</span> <span class="Identifier">errorLog</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Identifier">levelThreshold</span><span class="Operator">=</span><span class="Identifier">lvlError</span><span class="Punctuation">,</span> <span class="Identifier">useStderr</span><span class="Operator">=</span><span class="Identifier">true</span><span class="Punctuation">)</span></pre></p>
    547. 

  547. 

  548.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L405" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    549. 

  549. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L405" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    550. 

  550. 

  551.   </dd>
    552. 

  552. </div>
    553. 

  553. 

  554. </div>
    555. 

  555. <div id="newFileLogger-procs-all">
    556. 

  556.   <div id="newFileLogger,File">
    557. 

  557.   <dt><pre><span class="Keyword">proc</span> <a href="#newFileLogger%2CFile"><span class="Identifier">newFileLogger</span></a><span class="Other">(</span><span class="Identifier">file</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">levelThreshold</span> <span class="Other">=</span> <span class="Identifier">lvlAll</span><span class="Other">;</span> <span class="Identifier">fmtStr</span> <span class="Other">=</span> <span class="Identifier">defaultFmtStr</span><span class="Other">;</span>
    558. 

  558.                    <span class="Identifier">flushThreshold</span> <span class="Other">=</span> <span class="Identifier">defaultFlushThreshold</span><span class="Other">)</span><span class="Other">:</span> <a href="logging.html#FileLogger"><span class="Identifier">FileLogger</span></a> {.
    559. 

  559.     <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>
    560. 

  560.   <dd>
    561. 

  561.     
    562. 

  562.     <p>Creates a new <a class="reference external" href="#FileLogger">FileLogger</a> that uses the given file handle.</p>
    563. 

  563. <p><strong>Note:</strong> This proc is not available for the JavaScript backend.</p>
    564. 

  564. <p>See also:</p>
    565. 

  565. <ul class="simple"><li><a class="reference external" href="#newConsoleLogger">newConsoleLogger proc</a></li>
    566. 

  566. <li><a class="reference external" href="#newFileLogger,FileMode,int">newFileLogger proc</a> that accepts a filename</li>
    567. 

  567. <li><a class="reference external" href="#newRollingFileLogger,FileMode,Positive,int">newRollingFileLogger proc</a></li>
    568. 

  568. </ul>
    569. 

  569. <p><strong>Examples:</strong></p>
    570. 

  570. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">messages</span> <span class="Operator">=</span> <span class="Identifier">open</span><span class="Punctuation">(</span><span class="StringLit">&quot;messages.log&quot;</span><span class="Punctuation">,</span> <span class="Identifier">fmWrite</span><span class="Punctuation">)</span>
    571. 

  571. <span class="Keyword">var</span> <span class="Identifier">formatted</span> <span class="Operator">=</span> <span class="Identifier">open</span><span class="Punctuation">(</span><span class="StringLit">&quot;formatted.log&quot;</span><span class="Punctuation">,</span> <span class="Identifier">fmWrite</span><span class="Punctuation">)</span>
    572. 

  572. <span class="Keyword">var</span> <span class="Identifier">errors</span> <span class="Operator">=</span> <span class="Identifier">open</span><span class="Punctuation">(</span><span class="StringLit">&quot;errors.log&quot;</span><span class="Punctuation">,</span> <span class="Identifier">fmWrite</span><span class="Punctuation">)</span>
    573. 

  573. 

  574. <span class="Keyword">var</span> <span class="Identifier">normalLog</span> <span class="Operator">=</span> <span class="Identifier">newFileLogger</span><span class="Punctuation">(</span><span class="Identifier">messages</span><span class="Punctuation">)</span>
    575. 

  575. <span class="Keyword">var</span> <span class="Identifier">formatLog</span> <span class="Operator">=</span> <span class="Identifier">newFileLogger</span><span class="Punctuation">(</span><span class="Identifier">formatted</span><span class="Punctuation">,</span> <span class="Identifier">fmtStr</span><span class="Operator">=</span><span class="Identifier">verboseFmtStr</span><span class="Punctuation">)</span>
    576. 

  576. <span class="Keyword">var</span> <span class="Identifier">errorLog</span> <span class="Operator">=</span> <span class="Identifier">newFileLogger</span><span class="Punctuation">(</span><span class="Identifier">errors</span><span class="Punctuation">,</span> <span class="Identifier">levelThreshold</span><span class="Operator">=</span><span class="Identifier">lvlError</span><span class="Punctuation">)</span></pre></p>
    577. 

  577. 

  578.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L476" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    579. 

  579. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L476" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    580. 

  580. 

  581.   </dd>
    582. 

  582. </div>
    583. 

  583. <div id="newFileLogger,FileMode,int">
    584. 

  584.   <dt><pre><span class="Keyword">proc</span> <a href="#newFileLogger%2CFileMode%2Cint"><span class="Identifier">newFileLogger</span></a><span class="Other">(</span><span class="Identifier">filename</span> <span class="Other">=</span> <span class="Identifier">defaultFilename</span><span class="Other">(</span><span class="Other">)</span><span class="Other">;</span> <span class="Identifier">mode</span><span class="Other">:</span> <a href="syncio.html#FileMode"><span class="Identifier">FileMode</span></a> <span class="Other">=</span> <span class="Identifier">fmAppend</span><span class="Other">;</span>
    585. 

  585.                    <span class="Identifier">levelThreshold</span> <span class="Other">=</span> <span class="Identifier">lvlAll</span><span class="Other">;</span> <span class="Identifier">fmtStr</span> <span class="Other">=</span> <span class="Identifier">defaultFmtStr</span><span class="Other">;</span>
    586. 

  586.                    <span class="Identifier">bufSize</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">;</span> <span class="Identifier">flushThreshold</span> <span class="Other">=</span> <span class="Identifier">defaultFlushThreshold</span><span class="Other">)</span><span class="Other">:</span> <a href="logging.html#FileLogger"><span class="Identifier">FileLogger</span></a> {.
    587. 

  587.     <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="Identifier">IOError</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>
    588. 

  588.   <dd>
    589. 

  589.     
    590. 

  590.     <p>Creates a new <a class="reference external" href="#FileLogger">FileLogger</a> that logs to a file with the given filename.</p>
    591. 

  591. <p><tt class="docutils literal"><span class="pre">bufSize</span></tt> controls the size of the output buffer that is used when writing to the log file. The following values can be provided:</p>
    592. 

  592. <ul class="simple"><li><tt class="docutils literal"><span class="pre">-1</span></tt> - use system defaults</li>
    593. 

  593. <li><tt class="docutils literal"><span class="pre">0</span></tt> - unbuffered</li>
    594. 

  594. <li><tt class="docutils literal"><span class="pre">&gt; 0</span></tt> - fixed buffer size</li>
    595. 

  595. </ul>
    596. 

  596. <p><strong>Note:</strong> This proc is not available for the JavaScript backend.</p>
    597. 

  597. <p>See also:</p>
    598. 

  598. <ul class="simple"><li><a class="reference external" href="#newConsoleLogger">newConsoleLogger proc</a></li>
    599. 

  599. <li><a class="reference external" href="#newFileLogger,File">newFileLogger proc</a> that uses a file handle</li>
    600. 

  600. <li><a class="reference external" href="#newRollingFileLogger,FileMode,Positive,int">newRollingFileLogger proc</a></li>
    601. 

  601. </ul>
    602. 

  602. <p><strong>Examples:</strong></p>
    603. 

  603. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">normalLog</span> <span class="Operator">=</span> <span class="Identifier">newFileLogger</span><span class="Punctuation">(</span><span class="StringLit">&quot;messages.log&quot;</span><span class="Punctuation">)</span>
    604. 

  604. <span class="Keyword">var</span> <span class="Identifier">formatLog</span> <span class="Operator">=</span> <span class="Identifier">newFileLogger</span><span class="Punctuation">(</span><span class="StringLit">&quot;formatted.log&quot;</span><span class="Punctuation">,</span> <span class="Identifier">fmtStr</span><span class="Operator">=</span><span class="Identifier">verboseFmtStr</span><span class="Punctuation">)</span>
    605. 

  605. <span class="Keyword">var</span> <span class="Identifier">errorLog</span> <span class="Operator">=</span> <span class="Identifier">newFileLogger</span><span class="Punctuation">(</span><span class="StringLit">&quot;errors.log&quot;</span><span class="Punctuation">,</span> <span class="Identifier">levelThreshold</span><span class="Operator">=</span><span class="Identifier">lvlError</span><span class="Punctuation">)</span></pre></p>
    606. 

  606. 

  607.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L507" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    608. 

  608. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L507" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    609. 

  609. 

  610.   </dd>
    611. 

  611. </div>
    612. 

  612. 

  613. </div>
    614. 

  614. <div id="newRollingFileLogger-procs-all">
    615. 

  615.   <div id="newRollingFileLogger,FileMode,Positive,int">
    616. 

  616.   <dt><pre><span class="Keyword">proc</span> <a href="#newRollingFileLogger%2CFileMode%2CPositive%2Cint"><span class="Identifier">newRollingFileLogger</span></a><span class="Other">(</span><span class="Identifier">filename</span> <span class="Other">=</span> <span class="Identifier">defaultFilename</span><span class="Other">(</span><span class="Other">)</span><span class="Other">;</span>
    617. 

  617.                           <span class="Identifier">mode</span><span class="Other">:</span> <a href="syncio.html#FileMode"><span class="Identifier">FileMode</span></a> <span class="Other">=</span> <span class="Identifier">fmReadWrite</span><span class="Other">;</span> <span class="Identifier">levelThreshold</span> <span class="Other">=</span> <span class="Identifier">lvlAll</span><span class="Other">;</span>
    618. 

  618.                           <span class="Identifier">fmtStr</span> <span class="Other">=</span> <span class="Identifier">defaultFmtStr</span><span class="Other">;</span> <span class="Identifier">maxLines</span><span class="Other">:</span> <a href="system.html#Positive"><span class="Identifier">Positive</span></a> <span class="Other">=</span> <span class="DecNumber">1000</span><span class="Other">;</span>
    619. 

  619.                           <span class="Identifier">bufSize</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">;</span>
    620. 

  620.                           <span class="Identifier">flushThreshold</span> <span class="Other">=</span> <span class="Identifier">defaultFlushThreshold</span><span class="Other">)</span><span class="Other">:</span> <a href="logging.html#RollingFileLogger"><span class="Identifier">RollingFileLogger</span></a> {.
    621. 

  621.     <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="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadDirEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</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>
    622. 

  622.   <dd>
    623. 

  623.     
    624. 

  624.     <p>Creates a new <a class="reference external" href="#RollingFileLogger">RollingFileLogger</a>.</p>
    625. 

  625. <p>Once the current log file being written to contains <tt class="docutils literal"><span class="pre">maxLines</span></tt> lines, a new log file will be created, and the old log file will be renamed.</p>
    626. 

  626. <p><tt class="docutils literal"><span class="pre">bufSize</span></tt> controls the size of the output buffer that is used when writing to the log file. The following values can be provided:</p>
    627. 

  627. <ul class="simple"><li><tt class="docutils literal"><span class="pre">-1</span></tt> - use system defaults</li>
    628. 

  628. <li><tt class="docutils literal"><span class="pre">0</span></tt> - unbuffered</li>
    629. 

  629. <li><tt class="docutils literal"><span class="pre">&gt; 0</span></tt> - fixed buffer size</li>
    630. 

  630. </ul>
    631. 

  631. <p><strong>Note:</strong> This proc is not available in the JavaScript backend.</p>
    632. 

  632. <p>See also:</p>
    633. 

  633. <ul class="simple"><li><a class="reference external" href="#newConsoleLogger">newConsoleLogger proc</a></li>
    634. 

  634. <li><a class="reference external" href="#newFileLogger,File">newFileLogger proc</a> that uses a file handle</li>
    635. 

  635. <li><a class="reference external" href="#newFileLogger,FileMode,int">newFileLogger proc</a> that accepts a filename</li>
    636. 

  636. </ul>
    637. 

  637. <p><strong>Examples:</strong></p>
    638. 

  638. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">normalLog</span> <span class="Operator">=</span> <span class="Identifier">newRollingFileLogger</span><span class="Punctuation">(</span><span class="StringLit">&quot;messages.log&quot;</span><span class="Punctuation">)</span>
    639. 

  639. <span class="Keyword">var</span> <span class="Identifier">formatLog</span> <span class="Operator">=</span> <span class="Identifier">newRollingFileLogger</span><span class="Punctuation">(</span><span class="StringLit">&quot;formatted.log&quot;</span><span class="Punctuation">,</span> <span class="Identifier">fmtStr</span><span class="Operator">=</span><span class="Identifier">verboseFmtStr</span><span class="Punctuation">)</span>
    640. 

  640. <span class="Keyword">var</span> <span class="Identifier">shortLog</span> <span class="Operator">=</span> <span class="Identifier">newRollingFileLogger</span><span class="Punctuation">(</span><span class="StringLit">&quot;short.log&quot;</span><span class="Punctuation">,</span> <span class="Identifier">maxLines</span><span class="Operator">=</span><span class="DecNumber">200</span><span class="Punctuation">)</span>
    641. 

  641. <span class="Keyword">var</span> <span class="Identifier">errorLog</span> <span class="Operator">=</span> <span class="Identifier">newRollingFileLogger</span><span class="Punctuation">(</span><span class="StringLit">&quot;errors.log&quot;</span><span class="Punctuation">,</span> <span class="Identifier">levelThreshold</span><span class="Operator">=</span><span class="Identifier">lvlError</span><span class="Punctuation">)</span></pre></p>
    642. 

  642. 

  643.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L565" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    644. 

  644. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L565" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    645. 

  645. 

  646.   </dd>
    647. 

  647. </div>
    648. 

  648. 

  649. </div>
    650. 

  650. <div id="removeHandler-procs-all">
    651. 

  651.   <div id="removeHandler,Logger">
    652. 

  652.   <dt><pre><span class="Keyword">proc</span> <a href="#removeHandler%2CLogger"><span class="Identifier">removeHandler</span></a><span class="Other">(</span><span class="Identifier">handler</span><span class="Other">:</span> <a href="logging.html#Logger"><span class="Identifier">Logger</span></a><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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    653. 

  653.   <dd>
    654. 

  654.     
    655. 

  655.     <p>Removes a logger from the list of registered handlers.</p>
    656. 

  656. <p>Note that for n times a logger is registered, n calls to this proc are required to remove that logger.</p>
    657. 

  657. 

  658.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L851" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    659. 

  659. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L851" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    660. 

  660. 

  661.   </dd>
    662. 

  662. </div>
    663. 

  663. 

  664. </div>
    665. 

  665. <div id="setLogFilter-procs-all">
    666. 

  666.   <div id="setLogFilter,Level">
    667. 

  667.   <dt><pre><span class="Keyword">proc</span> <a href="#setLogFilter%2CLevel"><span class="Identifier">setLogFilter</span></a><span class="Other">(</span><span class="Identifier">lvl</span><span class="Other">:</span> <a href="logging.html#Level"><span class="Identifier">Level</span></a><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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    668. 

  668.   <dd>
    669. 

  669.     
    670. 

  670.     <p>Sets the global log filter.</p>
    671. 

  671. <p>Messages below the provided level will not be logged regardless of an individual logger's <tt class="docutils literal"><span class="pre">levelThreshold</span></tt>. By default, all messages are logged.</p>
    672. 

  672. <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    673. 

  673. The global log filter is a thread-local variable. If logging is being performed in multiple threads, this proc should be called in each thread unless it is intended that different threads should log at different logging levels.</div>
    674. 

  674. <p>See also:</p>
    675. 

  675. <ul class="simple"><li><a class="reference external" href="#getLogFilter">getLogFilter proc</a></li>
    676. 

  676. </ul>
    677. 

  677. 

  678. <p><strong class="examples_text">Example:</strong></p>
    679. 

  679. <pre class="listing"><span class="Identifier">setLogFilter</span><span class="Punctuation">(</span><span class="Identifier">lvlError</span><span class="Punctuation">)</span>
    680. 

  680. <span class="Identifier">doAssert</span> <span class="Identifier">getLogFilter</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">lvlError</span></pre>
    681. 

  681.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L868" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    682. 

  682. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L868" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    683. 

  683. 

  684.   </dd>
    685. 

  685. </div>
    686. 

  686. 

  687. </div>
    688. 

  688. <div id="substituteLog-procs-all">
    689. 

  689.   <div id="substituteLog,string,Level,varargs[string,]">
    690. 

  690.   <dt><pre><span class="Keyword">proc</span> <a href="#substituteLog%2Cstring%2CLevel%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">substituteLog</span></a><span class="Other">(</span><span class="Identifier">frmt</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">level</span><span class="Other">:</span> <a href="logging.html#Level"><span class="Identifier">Level</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    691. 

  691.     <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="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</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>
    692. 

  692.   <dd>
    693. 

  693.     
    694. 

  694.     <p>Formats a log message at the specified level with the given format string.</p>
    695. 

  695. <p>The <a class="reference external" href="#basic-usage-format-strings">format variables</a> present within <tt class="docutils literal"><span class="pre">frmt</span></tt> will be replaced with the corresponding values before being prepended to <tt class="docutils literal"><span class="pre">args</span></tt> and returned.</p>
    696. 

  696. <p>Unless you are implementing a custom logger, there is little need to call this directly. Use either a logger's log method or one of the logging templates.</p>
    697. 

  697. <p>See also:</p>
    698. 

  698. <ul class="simple"><li><a class="reference external" href="#log.e,ConsoleLogger,Level,varargs[string,]">log method</a> for the ConsoleLogger</li>
    699. 

  699. <li><a class="reference external" href="#log.e,FileLogger,Level,varargs[string,]">log method</a> for the FileLogger</li>
    700. 

  700. <li><a class="reference external" href="#log.e,RollingFileLogger,Level,varargs[string,]">log method</a> for the RollingFileLogger</li>
    701. 

  701. <li><a class="reference external" href="#log.t,Level,varargs[string,]">log template</a></li>
    702. 

  702. </ul>
    703. 

  703. 

  704. <p><strong class="examples_text">Example:</strong></p>
    705. 

  705. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">substituteLog</span><span class="Punctuation">(</span><span class="Identifier">defaultFmtStr</span><span class="Punctuation">,</span> <span class="Identifier">lvlInfo</span><span class="Punctuation">,</span> <span class="StringLit">&quot;a message&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;INFO a message&quot;</span>
    706. 

  706. <span class="Identifier">doAssert</span> <span class="Identifier">substituteLog</span><span class="Punctuation">(</span><span class="StringLit">&quot;$levelid - &quot;</span><span class="Punctuation">,</span> <span class="Identifier">lvlError</span><span class="Punctuation">,</span> <span class="StringLit">&quot;an error&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;E - an error&quot;</span>
    707. 

  707. <span class="Identifier">doAssert</span> <span class="Identifier">substituteLog</span><span class="Punctuation">(</span><span class="StringLit">&quot;$levelid&quot;</span><span class="Punctuation">,</span> <span class="Identifier">lvlDebug</span><span class="Punctuation">,</span> <span class="StringLit">&quot;error&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;Derror&quot;</span></pre>
    708. 

  708.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L287" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    709. 

  709. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L287" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    710. 

  710. 

  711.   </dd>
    712. 

  712. </div>
    713. 

  713. 

  714. </div>
    715. 

  715. 

  716.   </dl>
    717. 

  717. </div>
    718. 

  718. <div class="section" id="14">
    719. 

  719.   <h1><a class="toc-backref" href="#14">Methods</a></h1>
    720. 

  720.   <dl class="item">
    721. 

  721.     <div id="log-methods-all">
    722. 

  722.   <div id="log.e,ConsoleLogger,Level,varargs[string,]">
    723. 

  723.   <dt><pre><span class="Keyword">method</span> <a href="#log.e%2CConsoleLogger%2CLevel%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">log</span></a><span class="Other">(</span><span class="Identifier">logger</span><span class="Other">:</span> <a href="logging.html#ConsoleLogger"><span class="Identifier">ConsoleLogger</span></a><span class="Other">;</span> <span class="Identifier">level</span><span class="Other">:</span> <a href="logging.html#Level"><span class="Identifier">Level</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span> {.
    724. 

  724.     <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="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</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>
    725. 

  725.   <dd>
    726. 

  726.     
    727. 

  727.     <p>Logs to the console with the given <a class="reference external" href="#ConsoleLogger">ConsoleLogger</a> only.</p>
    728. 

  728. <p>This method ignores the list of registered handlers.</p>
    729. 

  729. <p>Whether the message is logged depends on both the ConsoleLogger's <tt class="docutils literal"><span class="pre">levelThreshold</span></tt> field and the global log filter set using the <a class="reference external" href="#setLogFilter,Level">setLogFilter proc</a>.</p>
    730. 

  730. <p><strong>Note:</strong> Only error and fatal messages will cause the output buffer to be flushed immediately by default. Set <tt class="docutils literal"><span class="pre">flushThreshold</span></tt> when creating the logger to change this.</p>
    731. 

  731. <p>See also:</p>
    732. 

  732. <ul class="simple"><li><a class="reference external" href="#log.e,FileLogger,Level,varargs[string,]">log method</a> for the FileLogger</li>
    733. 

  733. <li><a class="reference external" href="#log.e,RollingFileLogger,Level,varargs[string,]">log method</a> for the RollingFileLogger</li>
    734. 

  734. <li><a class="reference external" href="#log.t,Level,varargs[string,]">log template</a></li>
    735. 

  735. </ul>
    736. 

  736. <p><strong>Examples:</strong></p>
    737. 

  737. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">consoleLog</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    738. 

  738. <span class="Identifier">consoleLog</span><span class="Operator">.</span><span class="Identifier">log</span><span class="Punctuation">(</span><span class="Identifier">lvlInfo</span><span class="Punctuation">,</span> <span class="StringLit">&quot;this is a message&quot;</span><span class="Punctuation">)</span>
    739. 

  739. <span class="Identifier">consoleLog</span><span class="Operator">.</span><span class="Identifier">log</span><span class="Punctuation">(</span><span class="Identifier">lvlError</span><span class="Punctuation">,</span> <span class="StringLit">&quot;error code is: &quot;</span><span class="Punctuation">,</span> <span class="DecNumber">404</span><span class="Punctuation">)</span></pre></p>
    740. 

  740. 

  741.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L358" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    742. 

  742. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L358" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    743. 

  743. 

  744.   </dd>
    745. 

  745. </div>
    746. 

  746. <div id="log.e,FileLogger,Level,varargs[string,]">
    747. 

  747.   <dt><pre><span class="Keyword">method</span> <a href="#log.e%2CFileLogger%2CLevel%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">log</span></a><span class="Other">(</span><span class="Identifier">logger</span><span class="Other">:</span> <a href="logging.html#FileLogger"><span class="Identifier">FileLogger</span></a><span class="Other">;</span> <span class="Identifier">level</span><span class="Other">:</span> <a href="logging.html#Level"><span class="Identifier">Level</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span> {.
    748. 

  748.     <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="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span><span class="Other">,</span>
    749. 

  749.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    750. 

  750.   <dd>
    751. 

  751.     
    752. 

  752.     <p>Logs a message at the specified level using the given <a class="reference external" href="#FileLogger">FileLogger</a> only.</p>
    753. 

  753. <p>This method ignores the list of registered handlers.</p>
    754. 

  754. <p>Whether the message is logged depends on both the FileLogger's <tt class="docutils literal"><span class="pre">levelThreshold</span></tt> field and the global log filter set using the <a class="reference external" href="#setLogFilter,Level">setLogFilter proc</a>.</p>
    755. 

  755. <p><strong>Notes:</strong></p>
    756. 

  756. <ul class="simple"><li>Only error and fatal messages will cause the output buffer to be flushed immediately by default. Set <tt class="docutils literal"><span class="pre">flushThreshold</span></tt> when creating the logger to change this.</li>
    757. 

  757. <li>This method is not available for the JavaScript backend.</li>
    758. 

  758. </ul>
    759. 

  759. <p>See also:</p>
    760. 

  760. <ul class="simple"><li><a class="reference external" href="#log.e,ConsoleLogger,Level,varargs[string,]">log method</a> for the ConsoleLogger</li>
    761. 

  761. <li><a class="reference external" href="#log.e,RollingFileLogger,Level,varargs[string,]">log method</a> for the RollingFileLogger</li>
    762. 

  762. <li><a class="reference external" href="#log.t,Level,varargs[string,]">log template</a></li>
    763. 

  763. </ul>
    764. 

  764. <p><strong>Examples:</strong></p>
    765. 

  765. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">fileLog</span> <span class="Operator">=</span> <span class="Identifier">newFileLogger</span><span class="Punctuation">(</span><span class="StringLit">&quot;messages.log&quot;</span><span class="Punctuation">)</span>
    766. 

  766. <span class="Identifier">fileLog</span><span class="Operator">.</span><span class="Identifier">log</span><span class="Punctuation">(</span><span class="Identifier">lvlInfo</span><span class="Punctuation">,</span> <span class="StringLit">&quot;this is a message&quot;</span><span class="Punctuation">)</span>
    767. 

  767. <span class="Identifier">fileLog</span><span class="Operator">.</span><span class="Identifier">log</span><span class="Punctuation">(</span><span class="Identifier">lvlError</span><span class="Punctuation">,</span> <span class="StringLit">&quot;error code is: &quot;</span><span class="Punctuation">,</span> <span class="DecNumber">404</span><span class="Punctuation">)</span></pre></p>
    768. 

  768. 

  769.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L435" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    770. 

  770. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L435" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    771. 

  771. 

  772.   </dd>
    773. 

  773. </div>
    774. 

  774. <div id="log.e,Logger,Level,varargs[string,]">
    775. 

  775.   <dt><pre><span class="Keyword">method</span> <a href="#log.e%2CLogger%2CLevel%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">log</span></a><span class="Other">(</span><span class="Identifier">logger</span><span class="Other">:</span> <a href="logging.html#Logger"><span class="Identifier">Logger</span></a><span class="Other">;</span> <span class="Identifier">level</span><span class="Other">:</span> <a href="logging.html#Level"><span class="Identifier">Level</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span> {.
    776. 

  776.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="system.html#Exception"><span class="Identifier">Exception</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="system.html#RootEffect"><span class="Identifier">RootEffect</span></a><span class="Other">]</span><span class="Other">,</span> </span><span class="Identifier">base</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    777. 

  777.   <dd>
    778. 

  778.     
    779. 

  779.     <p>Override this method in custom loggers. The default implementation does nothing.</p>
    780. 

  780. <p>See also:</p>
    781. 

  781. <ul class="simple"><li><a class="reference external" href="#log.e,ConsoleLogger,Level,varargs[string,]">log method</a> for the ConsoleLogger</li>
    782. 

  782. <li><a class="reference external" href="#log.e,FileLogger,Level,varargs[string,]">log method</a> for the FileLogger</li>
    783. 

  783. <li><a class="reference external" href="#log.e,RollingFileLogger,Level,varargs[string,]">log method</a> for the RollingFileLogger</li>
    784. 

  784. <li><a class="reference external" href="#log.t,Level,varargs[string,]">log template</a></li>
    785. 

  785. </ul>
    786. 

  786. 

  787.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L342" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    788. 

  788. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L342" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    789. 

  789. 

  790.   </dd>
    791. 

  791. </div>
    792. 

  792. <div id="log.e,RollingFileLogger,Level,varargs[string,]">
    793. 

  793.   <dt><pre><span class="Keyword">method</span> <a href="#log.e%2CRollingFileLogger%2CLevel%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">log</span></a><span class="Other">(</span><span class="Identifier">logger</span><span class="Other">:</span> <a href="logging.html#RollingFileLogger"><span class="Identifier">RollingFileLogger</span></a><span class="Other">;</span> <span class="Identifier">level</span><span class="Other">:</span> <a href="logging.html#Level"><span class="Identifier">Level</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span> {.
    794. 

  794.     <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="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span>
    795. 

  795.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadDirEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</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>
    796. 

  796.   <dd>
    797. 

  797.     
    798. 

  798.     <p>Logs a message at the specified level using the given <a class="reference external" href="#RollingFileLogger">RollingFileLogger</a> only.</p>
    799. 

  799. <p>This method ignores the list of registered handlers.</p>
    800. 

  800. <p>Whether the message is logged depends on both the RollingFileLogger's <tt class="docutils literal"><span class="pre">levelThreshold</span></tt> field and the global log filter set using the <a class="reference external" href="#setLogFilter,Level">setLogFilter proc</a>.</p>
    801. 

  801. <p><strong>Notes:</strong></p>
    802. 

  802. <ul class="simple"><li>Only error and fatal messages will cause the output buffer to be flushed immediately by default. Set <tt class="docutils literal"><span class="pre">flushThreshold</span></tt> when creating the logger to change this.</li>
    803. 

  803. <li>This method is not available for the JavaScript backend.</li>
    804. 

  804. </ul>
    805. 

  805. <p>See also:</p>
    806. 

  806. <ul class="simple"><li><a class="reference external" href="#log.e,ConsoleLogger,Level,varargs[string,]">log method</a> for the ConsoleLogger</li>
    807. 

  807. <li><a class="reference external" href="#log.e,FileLogger,Level,varargs[string,]">log method</a> for the FileLogger</li>
    808. 

  808. <li><a class="reference external" href="#log.t,Level,varargs[string,]">log template</a></li>
    809. 

  809. </ul>
    810. 

  810. <p><strong>Examples:</strong></p>
    811. 

  811. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">rollingLog</span> <span class="Operator">=</span> <span class="Identifier">newRollingFileLogger</span><span class="Punctuation">(</span><span class="StringLit">&quot;messages.log&quot;</span><span class="Punctuation">)</span>
    812. 

  812. <span class="Identifier">rollingLog</span><span class="Operator">.</span><span class="Identifier">log</span><span class="Punctuation">(</span><span class="Identifier">lvlInfo</span><span class="Punctuation">,</span> <span class="StringLit">&quot;this is a message&quot;</span><span class="Punctuation">)</span>
    813. 

  813. <span class="Identifier">rollingLog</span><span class="Operator">.</span><span class="Identifier">log</span><span class="Punctuation">(</span><span class="Identifier">lvlError</span><span class="Punctuation">,</span> <span class="StringLit">&quot;error code is: &quot;</span><span class="Punctuation">,</span> <span class="DecNumber">404</span><span class="Punctuation">)</span></pre></p>
    814. 

  814. 

  815.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L623" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    816. 

  816. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L623" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    817. 

  817. 

  818.   </dd>
    819. 

  819. </div>
    820. 

  820. 

  821. </div>
    822. 

  822. 

  823.   </dl>
    824. 

  824. </div>
    825. 

  825. <div class="section" id="18">
    826. 

  826.   <h1><a class="toc-backref" href="#18">Templates</a></h1>
    827. 

  827.   <dl class="item">
    828. 

  828.     <div id="debug-templates-all">
    829. 

  829.   <div id="debug.t,varargs[string,]">
    830. 

  830.   <dt><pre><span class="Keyword">template</span> <a href="#debug.t%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">debug</span></a><span class="Other">(</span><span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
    831. 

  831.   <dd>
    832. 

  832.     
    833. 

  833.     <p>Logs a debug message to all registered handlers.</p>
    834. 

  834. <p>Debug messages are typically useful to the application developer only, and they are usually disabled in release builds, although this template does not make that distinction.</p>
    835. 

  835. <p><strong>Examples:</strong></p>
    836. 

  836. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">logger</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    837. 

  837. <span class="Identifier">addHandler</span><span class="Punctuation">(</span><span class="Identifier">logger</span><span class="Punctuation">)</span>
    838. 

  838. 

  839. <span class="Identifier">debug</span><span class="Punctuation">(</span><span class="StringLit">&quot;myProc called with arguments: foo, 5&quot;</span><span class="Punctuation">)</span></pre></p>
    840. 

  840. <p>See also:</p>
    841. 

  841. <ul class="simple"><li><a class="reference external" href="#log.t,Level,varargs[string,]">log template</a></li>
    842. 

  842. <li><a class="reference external" href="#info.t,varargs[string,]">info template</a></li>
    843. 

  843. <li><a class="reference external" href="#notice.t,varargs[string,]">notice template</a></li>
    844. 

  844. </ul>
    845. 

  845. 

  846.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L703" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    847. 

  847. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L703" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    848. 

  848. 

  849.   </dd>
    850. 

  850. </div>
    851. 

  851. 

  852. </div>
    853. 

  853. <div id="error-templates-all">
    854. 

  854.   <div id="error.t,varargs[string,]">
    855. 

  855.   <dt><pre><span class="Keyword">template</span> <a href="#error.t%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">error</span></a><span class="Other">(</span><span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
    856. 

  856.   <dd>
    857. 

  857.     
    858. 

  858.     <p>Logs an error message to all registered handlers.</p>
    859. 

  859. <p>Error messages are for application-level error conditions, such as when some user input generated an exception. Typically, the application will continue to run, but with degraded functionality or loss of data, and these effects might be visible to users.</p>
    860. 

  860. <p><strong>Examples:</strong></p>
    861. 

  861. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">logger</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    862. 

  862. <span class="Identifier">addHandler</span><span class="Punctuation">(</span><span class="Identifier">logger</span><span class="Punctuation">)</span>
    863. 

  863. 

  864. <span class="Identifier">error</span><span class="Punctuation">(</span><span class="StringLit">&quot;An exception occurred while processing the form.&quot;</span><span class="Punctuation">)</span></pre></p>
    865. 

  865. <p>See also:</p>
    866. 

  866. <ul class="simple"><li><a class="reference external" href="#log.t,Level,varargs[string,]">log template</a></li>
    867. 

  867. <li><a class="reference external" href="#warn.t,varargs[string,]">warn template</a></li>
    868. 

  868. <li><a class="reference external" href="#fatal.t,varargs[string,]">fatal template</a></li>
    869. 

  869. </ul>
    870. 

  870. 

  871.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L790" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    872. 

  872. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L790" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    873. 

  873. 

  874.   </dd>
    875. 

  875. </div>
    876. 

  876. 

  877. </div>
    878. 

  878. <div id="fatal-templates-all">
    879. 

  879.   <div id="fatal.t,varargs[string,]">
    880. 

  880.   <dt><pre><span class="Keyword">template</span> <a href="#fatal.t%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">fatal</span></a><span class="Other">(</span><span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
    881. 

  881.   <dd>
    882. 

  882.     
    883. 

  883.     <p>Logs a fatal error message to all registered handlers.</p>
    884. 

  884. <p>Fatal error messages usually indicate that the application cannot continue to run and will exit due to a fatal condition. This template only logs the message, and it is the application's responsibility to exit properly.</p>
    885. 

  885. <p><strong>Examples:</strong></p>
    886. 

  886. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">logger</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    887. 

  887. <span class="Identifier">addHandler</span><span class="Punctuation">(</span><span class="Identifier">logger</span><span class="Punctuation">)</span>
    888. 

  888. 

  889. <span class="Identifier">fatal</span><span class="Punctuation">(</span><span class="StringLit">&quot;Can't open database -- exiting.&quot;</span><span class="Punctuation">)</span></pre></p>
    890. 

  890. <p>See also:</p>
    891. 

  891. <ul class="simple"><li><a class="reference external" href="#log.t,Level,varargs[string,]">log template</a></li>
    892. 

  892. <li><a class="reference external" href="#warn.t,varargs[string,]">warn template</a></li>
    893. 

  893. <li><a class="reference external" href="#error.t,varargs[string,]">error template</a></li>
    894. 

  894. </ul>
    895. 

  895. 

  896.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L813" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    897. 

  897. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L813" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    898. 

  898. 

  899.   </dd>
    900. 

  900. </div>
    901. 

  901. 

  902. </div>
    903. 

  903. <div id="info-templates-all">
    904. 

  904.   <div id="info.t,varargs[string,]">
    905. 

  905.   <dt><pre><span class="Keyword">template</span> <a href="#info.t%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">info</span></a><span class="Other">(</span><span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
    906. 

  906.   <dd>
    907. 

  907.     
    908. 

  908.     <p>Logs an info message to all registered handlers.</p>
    909. 

  909. <p>Info messages are typically generated during the normal operation of an application and are of no particular importance. It can be useful to aggregate these messages for later analysis.</p>
    910. 

  910. <p><strong>Examples:</strong></p>
    911. 

  911. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">logger</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    912. 

  912. <span class="Identifier">addHandler</span><span class="Punctuation">(</span><span class="Identifier">logger</span><span class="Punctuation">)</span>
    913. 

  913. 

  914. <span class="Identifier">info</span><span class="Punctuation">(</span><span class="StringLit">&quot;Application started successfully.&quot;</span><span class="Punctuation">)</span></pre></p>
    915. 

  915. <p>See also:</p>
    916. 

  916. <ul class="simple"><li><a class="reference external" href="#log.t,Level,varargs[string,]">log template</a></li>
    917. 

  917. <li><a class="reference external" href="#debug.t,varargs[string,]">debug template</a></li>
    918. 

  918. <li><a class="reference external" href="#notice.t,varargs[string,]">notice template</a></li>
    919. 

  919. </ul>
    920. 

  920. 

  921.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L725" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    922. 

  922. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L725" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    923. 

  923. 

  924.   </dd>
    925. 

  925. </div>
    926. 

  926. 

  927. </div>
    928. 

  928. <div id="log-templates-all">
    929. 

  929.   <div id="log.t,Level,varargs[string,]">
    930. 

  930.   <dt><pre><span class="Keyword">template</span> <a href="#log.t%2CLevel%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">log</span></a><span class="Other">(</span><span class="Identifier">level</span><span class="Other">:</span> <a href="logging.html#Level"><span class="Identifier">Level</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
    931. 

  931.   <dd>
    932. 

  932.     
    933. 

  933.     <p>Logs a message at the specified level to all registered handlers.</p>
    934. 

  934. <p>Whether the message is logged depends on both the FileLogger's <tt class="docutils literal"><span class="pre"><span class="Identifier">levelThreshold</span></span></tt> field and the global log filter set using the <a class="reference external" href="#setLogFilter,Level">setLogFilter proc</a>.</p>
    935. 

  935. <p><strong>Examples:</strong></p>
    936. 

  936. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">logger</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    937. 

  937. <span class="Identifier">addHandler</span><span class="Punctuation">(</span><span class="Identifier">logger</span><span class="Punctuation">)</span>
    938. 

  938. 

  939. <span class="Identifier">log</span><span class="Punctuation">(</span><span class="Identifier">lvlInfo</span><span class="Punctuation">,</span> <span class="StringLit">&quot;This is an example.&quot;</span><span class="Punctuation">)</span></pre></p>
    940. 

  940. <p>See also:</p>
    941. 

  941. <ul class="simple"><li><a class="reference external" href="#debug.t,varargs[string,]">debug template</a></li>
    942. 

  942. <li><a class="reference external" href="#info.t,varargs[string,]">info template</a></li>
    943. 

  943. <li><a class="reference external" href="#notice.t,varargs[string,]">notice template</a></li>
    944. 

  944. <li><a class="reference external" href="#warn.t,varargs[string,]">warn template</a></li>
    945. 

  945. <li><a class="reference external" href="#error.t,varargs[string,]">error template</a></li>
    946. 

  946. <li><a class="reference external" href="#fatal.t,varargs[string,]">fatal template</a></li>
    947. 

  947. </ul>
    948. 

  948. 

  949.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L673" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    950. 

  950. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L673" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    951. 

  951. 

  952.   </dd>
    953. 

  953. </div>
    954. 

  954. 

  955. </div>
    956. 

  956. <div id="notice-templates-all">
    957. 

  957.   <div id="notice.t,varargs[string,]">
    958. 

  958.   <dt><pre><span class="Keyword">template</span> <a href="#notice.t%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">notice</span></a><span class="Other">(</span><span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
    959. 

  959.   <dd>
    960. 

  960.     
    961. 

  961.     <p>Logs an notice to all registered handlers.</p>
    962. 

  962. <p>Notices are semantically very similar to info messages, but they are meant to be messages that the user should be actively notified about, depending on the application.</p>
    963. 

  963. <p><strong>Examples:</strong></p>
    964. 

  964. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">logger</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    965. 

  965. <span class="Identifier">addHandler</span><span class="Punctuation">(</span><span class="Identifier">logger</span><span class="Punctuation">)</span>
    966. 

  966. 

  967. <span class="Identifier">notice</span><span class="Punctuation">(</span><span class="StringLit">&quot;An important operation has completed.&quot;</span><span class="Punctuation">)</span></pre></p>
    968. 

  968. <p>See also:</p>
    969. 

  969. <ul class="simple"><li><a class="reference external" href="#log.t,Level,varargs[string,]">log template</a></li>
    970. 

  970. <li><a class="reference external" href="#debug.t,varargs[string,]">debug template</a></li>
    971. 

  971. <li><a class="reference external" href="#info.t,varargs[string,]">info template</a></li>
    972. 

  972. </ul>
    973. 

  973. 

  974.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L747" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    975. 

  975. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L747" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    976. 

  976. 

  977.   </dd>
    978. 

  978. </div>
    979. 

  979. 

  980. </div>
    981. 

  981. <div id="warn-templates-all">
    982. 

  982.   <div id="warn.t,varargs[string,]">
    983. 

  983.   <dt><pre><span class="Keyword">template</span> <a href="#warn.t%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">warn</span></a><span class="Other">(</span><span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
    984. 

  984.   <dd>
    985. 

  985.     
    986. 

  986.     <p>Logs a warning message to all registered handlers.</p>
    987. 

  987. <p>A warning is a non-error message that may indicate impending problems or degraded performance.</p>
    988. 

  988. <p><strong>Examples:</strong></p>
    989. 

  989. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">logger</span> <span class="Operator">=</span> <span class="Identifier">newConsoleLogger</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    990. 

  990. <span class="Identifier">addHandler</span><span class="Punctuation">(</span><span class="Identifier">logger</span><span class="Punctuation">)</span>
    991. 

  991. 

  992. <span class="Identifier">warn</span><span class="Punctuation">(</span><span class="StringLit">&quot;The previous operation took too long to process.&quot;</span><span class="Punctuation">)</span></pre></p>
    993. 

  993. <p>See also:</p>
    994. 

  994. <ul class="simple"><li><a class="reference external" href="#log.t,Level,varargs[string,]">log template</a></li>
    995. 

  995. <li><a class="reference external" href="#error.t,varargs[string,]">error template</a></li>
    996. 

  996. <li><a class="reference external" href="#fatal.t,varargs[string,]">fatal template</a></li>
    997. 

  997. </ul>
    998. 

  998. 

  999.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/logging.nim#L769" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1000. 

  1000. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/logging.nim#L769" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1001. 

  1001. 

  1002.   </dd>
    1003. 

  1003. </div>
    1004. 

  1004. 

  1005. </div>
    1006. 

  1006. 

  1007.   </dl>
    1008. 

  1008. </div>
    1009. 

  1009. 

  1010.   </div>
    1011. 

  1011. </div>
    1012. 

  1012. 

  1013.       <div class="twelve-columns footer">
    1014. 

  1014.         <span class="nim-sprite"></span>
    1015. 

  1015.         <br>
    1016. 

  1016.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-03 14:57:14 UTC</small>
    1017. 

  1017.       </div>
    1018. 

  1018.     </div>
    1019. 

  1019.   </div>
    1020. 

  1020.       <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    1021. 

  1021.     
    1022. 

  1022. </body>
    1023. 

  1023. </html>
    1024. 

  1024.