index.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `traits` mod in crate `num`."><meta name="keywords" content="rust, rustlang, rust-lang, traits"><title>num::traits - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><p class='location'>Module traits</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>num</a></p><script>window.sidebarCurrent = {name: 'traits', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>num</a>::<wbr><a class="mod" href=''>traits</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/num/lib.rs.html#106-108' title='goto source code'>[src]</a></span></h1><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
  2. <table>
  3. <tr class=' module-item'>
  4. <td><a class="mod" href="bounds/index.html"
  5. title='mod num::traits::bounds'>bounds</a></td>
  6. <td class='docblock-short'>
  7. </td>
  8. </tr>
  9. <tr class=' module-item'>
  10. <td><a class="mod" href="cast/index.html"
  11. title='mod num::traits::cast'>cast</a></td>
  12. <td class='docblock-short'>
  13. </td>
  14. </tr>
  15. <tr class=' module-item'>
  16. <td><a class="mod" href="float/index.html"
  17. title='mod num::traits::float'>float</a></td>
  18. <td class='docblock-short'>
  19. </td>
  20. </tr>
  21. <tr class=' module-item'>
  22. <td><a class="mod" href="identities/index.html"
  23. title='mod num::traits::identities'>identities</a></td>
  24. <td class='docblock-short'>
  25. </td>
  26. </tr>
  27. <tr class=' module-item'>
  28. <td><a class="mod" href="int/index.html"
  29. title='mod num::traits::int'>int</a></td>
  30. <td class='docblock-short'>
  31. </td>
  32. </tr>
  33. <tr class=' module-item'>
  34. <td><a class="mod" href="ops/index.html"
  35. title='mod num::traits::ops'>ops</a></td>
  36. <td class='docblock-short'>
  37. </td>
  38. </tr>
  39. <tr class=' module-item'>
  40. <td><a class="mod" href="pow/index.html"
  41. title='mod num::traits::pow'>pow</a></td>
  42. <td class='docblock-short'>
  43. </td>
  44. </tr>
  45. <tr class=' module-item'>
  46. <td><a class="mod" href="real/index.html"
  47. title='mod num::traits::real'>real</a></td>
  48. <td class='docblock-short'>
  49. </td>
  50. </tr>
  51. <tr class=' module-item'>
  52. <td><a class="mod" href="sign/index.html"
  53. title='mod num::traits::sign'>sign</a></td>
  54. <td class='docblock-short'>
  55. </td>
  56. </tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
  57. <table>
  58. <tr class=' module-item'>
  59. <td><a class="struct" href="struct.ParseFloatError.html"
  60. title='struct num::traits::ParseFloatError'>ParseFloatError</a></td>
  61. <td class='docblock-short'>
  62. </td>
  63. </tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
  64. <table>
  65. <tr class=' module-item'>
  66. <td><a class="enum" href="enum.FloatErrorKind.html"
  67. title='enum num::traits::FloatErrorKind'>FloatErrorKind</a></td>
  68. <td class='docblock-short'>
  69. </td>
  70. </tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
  71. <table>
  72. <tr class=' module-item'>
  73. <td><a class="trait" href="trait.Num.html"
  74. title='trait num::traits::Num'>Num</a></td>
  75. <td class='docblock-short'>
  76. <p>The base trait for numeric types, covering <code>0</code> and <code>1</code> values,
  77. comparisons, basic numeric operations, and string conversion.</p>
  78. </td>
  79. </tr>
  80. <tr class=' module-item'>
  81. <td><a class="trait" href="trait.NumAssign.html"
  82. title='trait num::traits::NumAssign'>NumAssign</a></td>
  83. <td class='docblock-short'>
  84. <p>The trait for <code>Num</code> types which also implement assignment operators.</p>
  85. </td>
  86. </tr>
  87. <tr class=' module-item'>
  88. <td><a class="trait" href="trait.NumAssignOps.html"
  89. title='trait num::traits::NumAssignOps'>NumAssignOps</a></td>
  90. <td class='docblock-short'>
  91. <p>The trait for types implementing numeric assignment operators (like <code>+=</code>).</p>
  92. </td>
  93. </tr>
  94. <tr class=' module-item'>
  95. <td><a class="trait" href="trait.NumAssignRef.html"
  96. title='trait num::traits::NumAssignRef'>NumAssignRef</a></td>
  97. <td class='docblock-short'>
  98. <p>The trait for <code>NumAssign</code> types which also implement assignment operations
  99. taking the second operand by reference.</p>
  100. </td>
  101. </tr>
  102. <tr class=' module-item'>
  103. <td><a class="trait" href="trait.NumOps.html"
  104. title='trait num::traits::NumOps'>NumOps</a></td>
  105. <td class='docblock-short'>
  106. <p>The trait for types implementing basic numeric operations</p>
  107. </td>
  108. </tr>
  109. <tr class=' module-item'>
  110. <td><a class="trait" href="trait.NumRef.html"
  111. title='trait num::traits::NumRef'>NumRef</a></td>
  112. <td class='docblock-short'>
  113. <p>The trait for <code>Num</code> types which also implement numeric operations taking
  114. the second operand by reference.</p>
  115. </td>
  116. </tr>
  117. <tr class=' module-item'>
  118. <td><a class="trait" href="trait.RefNum.html"
  119. title='trait num::traits::RefNum'>RefNum</a></td>
  120. <td class='docblock-short'>
  121. <p>The trait for references which implement numeric operations, taking the
  122. second operand either by value or by reference.</p>
  123. </td>
  124. </tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
  125. <table>
  126. <tr class=' module-item'>
  127. <td><a class="fn" href="fn.clamp.html"
  128. title='fn num::traits::clamp'>clamp</a></td>
  129. <td class='docblock-short'>
  130. <p>A value bounded by a minimum and a maximum</p>
  131. </td>
  132. </tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "num";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>