HCoop / hcoop / debian / mlton.git / blame
| Commit | Line | Data |
|---|---|---|
| 7f918cf1 CE |
1 | <!DOCTYPE html>\r |
| 2 | <html lang="en">\r | |
| 3 | <head>\r | |
| 4 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">\r | |
| 5 | <meta name="generator" content="AsciiDoc 8.6.9">\r | |
| 6 | <title>MLtonWeak</title>\r | |
| 7 | <link rel="stylesheet" href="./asciidoc.css" type="text/css">\r | |
| 8 | <link rel="stylesheet" href="./pygments.css" type="text/css">\r | |
| 9 | \r | |
| 10 | \r | |
| 11 | <script type="text/javascript" src="./asciidoc.js"></script>\r | |
| 12 | <script type="text/javascript">\r | |
| 13 | /*<![CDATA[*/\r | |
| 14 | asciidoc.install();\r | |
| 15 | /*]]>*/\r | |
| 16 | </script>\r | |
| 17 | <link rel="stylesheet" href="./mlton.css" type="text/css">\r | |
| 18 | </head>\r | |
| 19 | <body class="article">\r | |
| 20 | <div id="banner">\r | |
| 21 | <div id="banner-home">\r | |
| 22 | <a href="./Home">MLton 20180207</a>\r | |
| 23 | </div>\r | |
| 24 | </div>\r | |
| 25 | <div id="header">\r | |
| 26 | <h1>MLtonWeak</h1>\r | |
| 27 | </div>\r | |
| 28 | <div id="content">\r | |
| 29 | <div id="preamble">\r | |
| 30 | <div class="sectionbody">\r | |
| 31 | <div class="listingblock">\r | |
| 32 | <div class="content"><div class="highlight"><pre><span class="k">signature</span><span class="w"> </span><span class="n">MLTON_WEAK</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r | |
| 33 | <span class="w"> </span><span class="k">sig</span><span class="w"></span>\r | |
| 34 | <span class="w"> </span><span class="k">type</span><span class="w"> </span><span class="n">'a</span><span class="w"> </span><span class="n">t</span><span class="w"></span>\r | |
| 35 | \r | |
| 36 | <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">get</span><span class="p">:</span><span class="w"> </span><span class="n">'a</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">-></span><span class="w"> </span><span class="n">'a</span><span class="w"> </span><span class="n">option</span><span class="w"></span>\r | |
| 37 | <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">new</span><span class="p">:</span><span class="w"> </span><span class="n">'a</span><span class="w"> </span><span class="p">-></span><span class="w"> </span><span class="n">'a</span><span class="w"> </span><span class="n">t</span><span class="w"></span>\r | |
| 38 | <span class="w"> </span><span class="k">end</span><span class="w"></span>\r | |
| 39 | </pre></div></div></div>\r | |
| 40 | <div class="paragraph"><p>A weak pointer is a pointer to an object that is nulled if the object\r | |
| 41 | becomes <a href="Reachability">unreachable</a> due to garbage collection. The\r | |
| 42 | weak pointer does not itself cause the object it points to be retained\r | |
| 43 | by the garbage collector — only other strong pointers can do that.\r | |
| 44 | For objects that are not allocated in the heap, like integers, a weak\r | |
| 45 | pointer will always be nulled. So, if <span class="monospaced">w: int Weak.t</span>, then\r | |
| 46 | <span class="monospaced">Weak.get w = NONE</span>.</p></div>\r | |
| 47 | <div class="ulist"><ul>\r | |
| 48 | <li>\r | |
| 49 | <p>\r | |
| 50 | <span class="monospaced">type 'a t</span>\r | |
| 51 | </p>\r | |
| 52 | <div class="paragraph"><p>the type of weak pointers to objects of type <span class="monospaced">'a</span></p></div>\r | |
| 53 | </li>\r | |
| 54 | <li>\r | |
| 55 | <p>\r | |
| 56 | <span class="monospaced">get w</span>\r | |
| 57 | </p>\r | |
| 58 | <div class="paragraph"><p>returns <span class="monospaced">NONE</span> if the object pointed to by <span class="monospaced">w</span> no longer exists.\r | |
| 59 | Otherwise, returns <span class="monospaced">SOME</span> of the object pointed to by <span class="monospaced">w</span>.</p></div>\r | |
| 60 | </li>\r | |
| 61 | <li>\r | |
| 62 | <p>\r | |
| 63 | <span class="monospaced">new x</span>\r | |
| 64 | </p>\r | |
| 65 | <div class="paragraph"><p>returns a weak pointer to <span class="monospaced">x</span>.</p></div>\r | |
| 66 | </li>\r | |
| 67 | </ul></div>\r | |
| 68 | </div>\r | |
| 69 | </div>\r | |
| 70 | </div>\r | |
| 71 | <div id="footnotes"><hr></div>\r | |
| 72 | <div id="footer">\r | |
| 73 | <div id="footer-text">\r | |
| 74 | </div>\r | |
| 75 | <div id="footer-badges">\r | |
| 76 | </div>\r | |
| 77 | </div>\r | |
| 78 | </body>\r | |
| 79 | </html>\r |