zig

fork of https://codeberg.org/ziglang/zig
Log | Files | Refs | README | LICENSE

index.html (12786B) - Raw


      1 <!doctype html>
      2 <html>
      3   <head>
      4     <meta charset="utf-8">
      5     <meta name="viewport" content="width=device-width, initial-scale=1.0">
      6     <title>Zig Documentation</title>
      7     <link rel="icon" href="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxNTMgMTQwIj48ZyBmaWxsPSIjRjdBNDFEIj48Zz48cG9seWdvbiBwb2ludHM9IjQ2LDIyIDI4LDQ0IDE5LDMwIi8+PHBvbHlnb24gcG9pbnRzPSI0NiwyMiAzMywzMyAyOCw0NCAyMiw0NCAyMiw5NSAzMSw5NSAyMCwxMDAgMTIsMTE3IDAsMTE3IDAsMjIiIHNoYXBlLXJlbmRlcmluZz0iY3Jpc3BFZGdlcyIvPjxwb2x5Z29uIHBvaW50cz0iMzEsOTUgMTIsMTE3IDQsMTA2Ii8+PC9nPjxnPjxwb2x5Z29uIHBvaW50cz0iNTYsMjIgNjIsMzYgMzcsNDQiLz48cG9seWdvbiBwb2ludHM9IjU2LDIyIDExMSwyMiAxMTEsNDQgMzcsNDQgNTYsMzIiIHNoYXBlLXJlbmRlcmluZz0iY3Jpc3BFZGdlcyIvPjxwb2x5Z29uIHBvaW50cz0iMTE2LDk1IDk3LDExNyA5MCwxMDQiLz48cG9seWdvbiBwb2ludHM9IjExNiw5NSAxMDAsMTA0IDk3LDExNyA0MiwxMTcgNDIsOTUiIHNoYXBlLXJlbmRlcmluZz0iY3Jpc3BFZGdlcyIvPjxwb2x5Z29uIHBvaW50cz0iMTUwLDAgNTIsMTE3IDMsMTQwIDEwMSwyMiIvPjwvZz48Zz48cG9seWdvbiBwb2ludHM9IjE0MSwyMiAxNDAsNDAgMTIyLDQ1Ii8+PHBvbHlnb24gcG9pbnRzPSIxNTMsMjIgMTUzLDExNyAxMDYsMTE3IDEyMCwxMDUgMTI1LDk1IDEzMSw5NSAxMzEsNDUgMTIyLDQ1IDEzMiwzNiAxNDEsMjIiIHNoYXBlLXJlbmRlcmluZz0iY3Jpc3BFZGdlcyIvPjxwb2x5Z29uIHBvaW50cz0iMTI1LDk1IDEzMCwxMTAgMTA2LDExNyIvPjwvZz48L2c+PC9zdmc+">
      8     <style type="text/css">
      9       *, *::before, *::after {
     10         box-sizing: border-box;
     11       }
     12       body {
     13         font-family: system-ui, -apple-system, Roboto, "Segoe UI", sans-serif;
     14         color: #000000;
     15       }
     16       .hidden {
     17         display: none;
     18       }
     19       table {
     20         width: 100%;
     21       }
     22       a {
     23         color: #2A6286;
     24       }
     25       pre{
     26         font-family:"Source Code Pro",monospace;
     27         font-size:1em;
     28         background-color:#F5F5F5;
     29         padding: 1em;
     30         margin: 0;
     31         overflow-x: auto;
     32       }
     33       :not(pre) > code {
     34         white-space: break-spaces;
     35       }
     36       code {
     37         font-family:"Source Code Pro",monospace;
     38         font-size: 0.9em;
     39       }
     40       code a {
     41         color: #000000;
     42       }
     43       #listFields > div, #listParams > div {
     44         margin-bottom: 1em;
     45       }
     46       #hdrName a {
     47         font-size: 0.7em;
     48         padding-left: 1em;
     49       }
     50       .fieldDocs {
     51         border: 1px solid #F5F5F5;
     52         border-top: 0px;
     53         padding: 1px 1em;
     54       }
     55 
     56       #logo {
     57         width: 8em;
     58         padding: 0.5em 1em;
     59       }
     60 
     61       #navWrap {
     62         width: -moz-available;
     63         width: -webkit-fill-available;
     64         width: stretch;
     65         margin-left: 11em;
     66       }
     67 
     68       #search {
     69         width: 100%;
     70       }
     71 
     72       nav {
     73         width: 10em;
     74         float: left;
     75       }
     76       nav h2 {
     77         font-size: 1.2em;
     78         text-decoration: underline;
     79         margin: 0;
     80         padding: 0.5em 0;
     81         text-align: center;
     82       }
     83       nav p {
     84         margin: 0;
     85         padding: 0;
     86         text-align: center;
     87       }
     88       section {
     89         clear: both;
     90         padding-top: 1em;
     91       }
     92       section h1 {
     93         border-bottom: 1px dashed;
     94         margin: 0 0;
     95       }
     96       section h2 {
     97         font-size: 1.3em;
     98         margin: 0.5em 0;
     99         padding: 0;
    100         border-bottom: 1px solid;
    101       }
    102       #listNav {
    103         list-style-type: none;
    104         margin: 0.5em 0 0 0;
    105         padding: 0;
    106         overflow: hidden;
    107         background-color: #f1f1f1;
    108       }
    109       #listNav li {
    110         float:left;
    111       }
    112       #listNav li a {
    113         display: block;
    114         color: #000;
    115         text-align: center;
    116         padding: .5em .8em;
    117         text-decoration: none;
    118       }
    119       #listNav li a:hover {
    120         background-color: #555;
    121         color: #fff;
    122       }
    123       #listNav li a.active {
    124         background-color: #FFBB4D;
    125         color: #000;
    126       }
    127 
    128       #helpDialog {
    129         width: 21em;
    130         height: 21em;
    131         position: fixed;
    132         top: 0;
    133         left: 0;
    134         background-color: #333;
    135         color: #fff;
    136         border: 1px solid #fff;
    137       }
    138       #helpDialog h1 {
    139         text-align: center;
    140         font-size: 1.5em;
    141       }
    142       #helpDialog dt, #helpDialog dd {
    143         display: inline;
    144         margin: 0 0.2em;
    145       }
    146       kbd {
    147         color: #000;
    148         background-color: #fafbfc;
    149         border-color: #d1d5da;
    150         border-bottom-color: #c6cbd1;
    151         box-shadow-color: #c6cbd1;
    152         display: inline-block;
    153         padding: 0.3em 0.2em;
    154         font: 1.2em monospace;
    155         line-height: 0.8em;
    156         vertical-align: middle;
    157         border: solid 1px;
    158         border-radius: 3px;
    159         box-shadow: inset 0 -1px 0;
    160         cursor: default;
    161       }
    162 
    163       #errors {
    164         background-color: #faa;
    165         position: fixed;
    166         left: 0;
    167         bottom: 0;
    168         width: 100%;
    169         max-height: min(20em, 50vh);
    170         padding: 0.5em;
    171         overflow: auto;
    172       }
    173       #errors h1 {
    174         font-size: 1.5em;
    175       }
    176       #errors pre {
    177         background-color: #fcc;
    178       }
    179 
    180       #listSearchResults li.selected {
    181         background-color: #93e196;
    182       }
    183 
    184       #tableFnErrors dt {
    185         font-weight: bold;
    186       }
    187 
    188       dl > div {
    189           padding: 0.5em;
    190           border: 1px solid #c0c0c0;
    191           margin-top: 0.5em;
    192       }
    193 
    194       td, th {
    195         text-align: unset;
    196         vertical-align: top;
    197         margin: 0;
    198         padding: 0.5em;
    199         max-width: 20em;
    200         text-overflow: ellipsis;
    201         overflow-x: hidden;
    202       }
    203 
    204       ul.columns {
    205         column-width: 20em;
    206       }
    207 
    208       .tok-kw {
    209           color: #333;
    210           font-weight: bold;
    211       }
    212       .tok-str {
    213           color: #d14;
    214       }
    215       .tok-builtin {
    216           color: #0086b3;
    217       }
    218       .tok-comment {
    219           color: #777;
    220           font-style: italic;
    221       }
    222       .tok-fn {
    223           color: #900;
    224           font-weight: bold;
    225       }
    226       .tok-null {
    227           color: #008080;
    228       }
    229       .tok-number {
    230           color: #008080;
    231       }
    232       .tok-type {
    233           color: #458;
    234           font-weight: bold;
    235       }
    236 
    237       @media (prefers-color-scheme: dark) {
    238         body {
    239           background-color: #111;
    240           color: #bbb;
    241         }
    242         pre {
    243           background-color: #222;
    244           color: #ccc;
    245         }
    246         a {
    247           color: #88f;
    248         }
    249         code a {
    250           color: #ccc;
    251         }
    252         .fieldDocs {
    253           border-color:#2A2A2A;
    254         }
    255         #listNav {
    256           background-color: #333;
    257         }
    258         #listNav li a {
    259           color: #fff;
    260         }
    261         #listNav li a:hover {
    262           background-color: #555;
    263           color: #fff;
    264         }
    265         #listNav li a.active {
    266           background-color: #FFBB4D;
    267           color: #000;
    268         }
    269         #listSearchResults li.selected {
    270           background-color: #000;
    271         }
    272         #listSearchResults li.selected a {
    273           color: #fff;
    274         }
    275         #errors {
    276           background-color: #800;
    277           color: #fff;
    278         }
    279         #errors pre {
    280           background-color: #a00;
    281           color: #fff;
    282         }
    283         dl > div {
    284           border-color: #373737;
    285         }
    286         .tok-kw {
    287             color: #eee;
    288         }
    289         .tok-str {
    290             color: #2e5;
    291         }
    292         .tok-builtin {
    293             color: #ff894c;
    294         }
    295         .tok-comment {
    296             color: #aa7;
    297         }
    298         .tok-fn {
    299             color: #B1A0F8;
    300         }
    301         .tok-null {
    302             color: #ff8080;
    303         }
    304         .tok-number {
    305             color: #ff8080;
    306         }
    307         .tok-type {
    308             color: #68f;
    309         }
    310       }
    311     </style>
    312   </head>
    313   <body>
    314     <nav>
    315       <a class="logo" href="#">
    316         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 400 140">
    317         <g fill="#F7A41D">
    318           <g>
    319             <polygon points="46,22 28,44 19,30"/>
    320             <polygon points="46,22 33,33 28,44 22,44 22,95 31,95 20,100 12,117 0,117 0,22" shape-rendering="crispEdges"/>
    321             <polygon points="31,95 12,117 4,106"/>
    322           </g>
    323           <g>
    324             <polygon points="56,22 62,36 37,44"/>
    325             <polygon points="56,22 111,22 111,44 37,44 56,32" shape-rendering="crispEdges"/>
    326             <polygon points="116,95 97,117 90,104"/>
    327             <polygon points="116,95 100,104 97,117 42,117 42,95" shape-rendering="crispEdges"/>
    328             <polygon points="150,0 52,117 3,140 101,22"/>
    329           </g>
    330           <g>
    331             <polygon points="141,22 140,40 122,45"/>
    332             <polygon points="153,22 153,117 106,117 120,105 125,95 131,95 131,45 122,45 132,36 141,22" shape-rendering="crispEdges"/>
    333             <polygon points="125,95 130,110 106,117"/>
    334           </g>
    335         </g>
    336         <style>
    337         #text { fill: #121212 }
    338         @media (prefers-color-scheme: dark) { #text { fill: #f2f2f2 } }
    339         </style>
    340         <g id="text">
    341           <g>
    342             <polygon points="260,22 260,37 229,40 177,40 177,22" shape-rendering="crispEdges"/>
    343             <polygon points="260,37 207,99 207,103 176,103 229,40 229,37"/>
    344             <polygon points="261,99 261,117 176,117 176,103 206,99" shape-rendering="crispEdges"/>
    345           </g>
    346           <rect x="272" y="22" shape-rendering="crispEdges" width="22" height="95"/>
    347           <g>
    348             <polygon points="394,67 394,106 376,106 376,81 360,70 346,67" shape-rendering="crispEdges"/>
    349             <polygon points="360,68 376,81 346,67"/>
    350             <path d="M394,106c-10.2,7.3-24,12-37.7,12c-29,0-51.1-20.8-51.1-48.3c0-27.3,22.5-48.1,52-48.1    c14.3,0,29.2,5.5,38.9,14l-13,15c-7.1-6.3-16.8-10-25.9-10c-17,0-30.2,12.9-30.2,29.5c0,16.8,13.3,29.6,30.3,29.6    c5.7,0,12.8-2.3,19-5.5L394,106z"/>
    351           </g>
    352         </g>
    353         </svg>
    354       </a>
    355     </nav>
    356     <div id="navWrap">
    357       <input type="search" id="search" autocomplete="off" spellcheck="false" placeholder="`s` to search, `?` to see more options">
    358       <div id="sectNav" class="hidden"><ul id="listNav"></ul></div>
    359     </div>
    360     <section>
    361     <p id="status">Loading...</p>
    362     <h1 id="hdrName" class="hidden"><span></span><a href="#">[src]</a></h1>
    363     <div id="fnProto" class="hidden">
    364       <pre><code id="fnProtoCode"></code></pre>
    365     </div>
    366     <div id="tldDocs" class="hidden"></div>
    367     <div id="sectParams" class="hidden">
    368       <h2>Parameters</h2>
    369       <div id="listParams">
    370       </div>
    371     </div>
    372     <div id="sectFnErrors" class="hidden">
    373       <h2>Errors</h2>
    374       <div id="fnErrorsAnyError">
    375         <p><span class="tok-type">anyerror</span> means the error set is known only at runtime.</p>
    376       </div>
    377       <div id="tableFnErrors"><dl id="listFnErrors"></dl></div>
    378     </div>
    379     <div id="sectSearchResults" class="hidden">
    380       <h2>Search Results</h2>
    381       <ul id="listSearchResults"></ul>
    382     </div>
    383     <div id="sectSearchNoResults" class="hidden">
    384       <h2>No Results Found</h2>
    385       <p>Press escape to exit search and then '?' to see more options.</p>
    386     </div>
    387     <div id="sectFields" class="hidden">
    388       <h2>Fields</h2>
    389       <div id="listFields">
    390       </div>
    391     </div>
    392     <div id="sectTypes" class="hidden">
    393       <h2>Types</h2>
    394       <ul id="listTypes" class="columns">
    395       </ul>
    396     </div>
    397     <div id="sectNamespaces" class="hidden">
    398       <h2>Namespaces</h2>
    399       <ul id="listNamespaces" class="columns">
    400       </ul>
    401     </div>
    402     <div id="sectGlobalVars" class="hidden">
    403       <h2>Global Variables</h2>
    404       <table>
    405         <tbody id="listGlobalVars">
    406         </tbody>
    407       </table>
    408     </div>
    409     <div id="sectValues" class="hidden">
    410       <h2>Values</h2>
    411       <table>
    412         <tbody id="listValues">
    413         </tbody>
    414       </table>
    415     </div>
    416     <div id="sectFns" class="hidden">
    417       <h2>Functions</h2>
    418       <dl id="listFns">
    419       </dl>
    420     </div>
    421     <div id="sectErrSets" class="hidden">
    422       <h2>Error Sets</h2>
    423       <ul id="listErrSets" class="columns">
    424       </ul>
    425     </div>
    426     <div id="sectDocTests" class="hidden">
    427       <h2>Example Usage</h2>
    428       <pre><code id="docTestsCode"></code></pre>
    429     </div>
    430     <div id="sectSource" class="hidden">
    431       <h2>Source Code</h2>
    432       <pre><code id="sourceText"></code></pre>
    433     </div>
    434     </section>
    435     <div id="helpDialog" class="hidden">
    436       <h1>Keyboard Shortcuts</h1>
    437       <dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd></dl>
    438       <dl><dt><kbd>Esc</kbd></dt><dd>Clear focus; close this dialog</dd></dl>
    439       <dl><dt><kbd>s</kbd></dt><dd>Focus the search field</dd></dl>
    440       <dl><dt><kbd>u</kbd></dt><dd>Go to source code</dd></dl>
    441       <dl><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd></dl>
    442       <dl><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd></dl>
    443       <dl><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd></dl>
    444     </div>
    445     <div id="errors" class="hidden">
    446       <h1>Errors</h1>
    447       <pre id="errorsText"></pre>
    448     </div>
    449     <script src="main.js"></script>
    450   </body>
    451 </html>
    452