Nixyri/zig
1
0
Fork 0
mirror of https://github.com/ziglang/zig.git synced 2024-11-14 16:13:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
bfcf18c5a7
zig/doc/langref.html.in

8267 lines
331 KiB
HTML
Raw Normal View History

std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<!doctype html>
docs: add html lang and minor fixes
2019-12-05 21:38:59 +00:00
<html lang="en">
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<head>
<meta charset="utf-8">
Add meta viewport to fix mobile rendering, add missing <code> block Co-authored-by: Vexu <git@vexu.eu>
2020-07-27 14:10:55 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1.0">
langref now sets color-scheme
2024-02-03 14:06:18 +00:00
<meta name="color-scheme" content="light dark">
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<title>Documentation - The Zig Programming Language</title>
langref: remove the trailing slash from the link element A self-closing tag for void elements like link is only required under XHTML 1.0. See https://developer.mozilla.org/en-US/docs/Glossary/Void_element#self-closing_tags.
2022-12-12 10:43:41 +00:00
<link rel="icon" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAgklEQVR4AWMYWuD7EllJIM4G4g4g5oIJ/odhOJ8wToOxSTXgNxDHoeiBMfA4+wGShjyYOCkG/IGqWQziEzYAoUAeiF9D5U+DxEg14DRU7jWIT5IBIOdCxf+A+CQZAAoopEB7QJwBCBwHiip8UYmRdrAlDpIMgApwQZNnNii5Dq0MBgCxxycBnwEd+wAAAABJRU5ErkJggg==">
Add embedded SVG favicon to reference doc templates The SVG looks way better than the pixelated PNG and will adapt best to whatever screen it is being displayed on. The PNG continues to be used because Apple Safari does not support SVG favicons yet. All other major browsers do. See https://caniuse.com/link-icon-svg. This is a companion PR to ziglang/www.ziglang.org#310.
2023-09-24 18:17:30 +00:00
<link rel="icon" href="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxNTMgMTQwIj48ZyBmaWxsPSIjRjdBNDFEIj48Zz48cG9seWdvbiBwb2ludHM9IjQ2LDIyIDI4LDQ0IDE5LDMwIi8+PHBvbHlnb24gcG9pbnRzPSI0NiwyMiAzMywzMyAyOCw0NCAyMiw0NCAyMiw5NSAzMSw5NSAyMCwxMDAgMTIsMTE3IDAsMTE3IDAsMjIiIHNoYXBlLXJlbmRlcmluZz0iY3Jpc3BFZGdlcyIvPjxwb2x5Z29uIHBvaW50cz0iMzEsOTUgMTIsMTE3IDQsMTA2Ii8+PC9nPjxnPjxwb2x5Z29uIHBvaW50cz0iNTYsMjIgNjIsMzYgMzcsNDQiLz48cG9seWdvbiBwb2ludHM9IjU2LDIyIDExMSwyMiAxMTEsNDQgMzcsNDQgNTYsMzIiIHNoYXBlLXJlbmRlcmluZz0iY3Jpc3BFZGdlcyIvPjxwb2x5Z29uIHBvaW50cz0iMTE2LDk1IDk3LDExNyA5MCwxMDQiLz48cG9seWdvbiBwb2ludHM9IjExNiw5NSAxMDAsMTA0IDk3LDExNyA0MiwxMTcgNDIsOTUiIHNoYXBlLXJlbmRlcmluZz0iY3Jpc3BFZGdlcyIvPjxwb2x5Z29uIHBvaW50cz0iMTUwLDAgNTIsMTE3IDMsMTQwIDEwMSwyMiIvPjwvZz48Zz48cG9seWdvbiBwb2ludHM9IjE0MSwyMiAxNDAsNDAgMTIyLDQ1Ii8+PHBvbHlnb24gcG9pbnRzPSIxNTMsMjIgMTUzLDExNyAxMDYsMTE3IDEyMCwxMDUgMTI1LDk1IDEzMSw5NSAxMzEsNDUgMTIyLDQ1IDEzMiwzNiAxNDEsMjIiIHNoYXBlLXJlbmRlcmluZz0iY3Jpc3BFZGdlcyIvPjxwb2x5Z29uIHBvaW50cz0iMTI1LDk1IDEzMCwxMTAgMTA2LDExNyIvPjwvZz48L2c+PC9zdmc+">
docs: add html lang and minor fixes
2019-12-05 21:38:59 +00:00
<style>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
:root{
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
--nav-width: 26em;
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
--nav-margin-l: 1em;
}
langref: dark style. easier on the eyes
2018-10-24 02:11:31 +00:00
body{
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
font-family: system-ui, -apple-system, Roboto, "Segoe UI", sans-serif;
langref table of contents in a separate column on large displays
2019-10-23 10:55:20 +00:00
margin: 0;
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
line-height: 1.5;
langref: dark style. easier on the eyes
2018-10-24 02:11:31 +00:00
}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
header {
padding: 0 1em;
langref: dark style. easier on the eyes
2018-10-24 02:11:31 +00:00
}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
#contents {
max-width: 60em;
margin: auto;
padding: 0 1em;
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
#navigation {
padding: 0 1em;
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
}
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
table ul {
list-style-type: none;
padding: 0em;
}
table li {
padding-bottom: 1em;
line-height:1.2em;
}
table, th, td {
border-collapse: collapse;
border: 1px solid grey;
}
th, td {
padding: 0.5em;
}
th[scope=row] {
text-align: left;
font-weight: normal;
}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
@media screen and (min-width: 1025px) {
header {
margin-left: calc(var(--nav-width) + var(--nav-margin-l));
}
header h1 {
margin: auto;
max-width: 30em;
}
#navigation {
overflow: auto;
width: var(--nav-width);
height: 100vh;
position: fixed;
top:0;
left:0;
bottom:0;
padding: unset;
margin-left: var(--nav-margin-l);
}
#navigation nav ul {
padding-left: 1em;
}
#contents-wrapper {
margin-left: calc(var(--nav-width) + var(--nav-margin-l));
}
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
a:hover,a:focus {
background: #fff2a8;
}
dt {
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
font-weight: bold;
}
docgen: improve the termColor function Make the termColor function more robust, ensuring that the generated HTML classes are more consistent and that they are supported in the CSS. Add documentation about the ANSI codes generated by Zig, and remove the previous comment with the supported colors. Improve test coverage for the termColor function, and move the tests at the end of the file before the printShell tests. Rename the "term color" test to "term supported colors" and add an additional "term output from zig" test, using test data generated from the Zig compiler. Update the langref.html.in CSS to use the new names and remove incorrect or obsolete colors like .t0_1, .t37 and .t37_1. Fix support for the 1m color. Change font-weight to normal for the kbd element, to avoid both the command (like `zig build-exe`) and the first line of the error message having a bold font. Rename the "shell parsed" test to "printShell".
2023-02-25 10:14:43 +00:00
.sgr-1m {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
font-weight: bold;
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
}
docgen: improve the termColor function Make the termColor function more robust, ensuring that the generated HTML classes are more consistent and that they are supported in the CSS. Add documentation about the ANSI codes generated by Zig, and remove the previous comment with the supported colors. Improve test coverage for the termColor function, and move the tests at the end of the file before the printShell tests. Rename the "term color" test to "term supported colors" and add an additional "term output from zig" test, using test data generated from the Zig compiler. Update the langref.html.in CSS to use the new names and remove incorrect or obsolete colors like .t0_1, .t37 and .t37_1. Fix support for the 1m color. Change font-weight to normal for the kbd element, to avoid both the command (like `zig build-exe`) and the first line of the error message having a bold font. Rename the "shell parsed" test to "printShell".
2023-02-25 10:14:43 +00:00
.sgr-2m {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: #575757;
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
}
docgen: improve the termColor function Make the termColor function more robust, ensuring that the generated HTML classes are more consistent and that they are supported in the CSS. Add documentation about the ANSI codes generated by Zig, and remove the previous comment with the supported colors. Improve test coverage for the termColor function, and move the tests at the end of the file before the printShell tests. Rename the "term color" test to "term supported colors" and add an additional "term output from zig" test, using test data generated from the Zig compiler. Update the langref.html.in CSS to use the new names and remove incorrect or obsolete colors like .t0_1, .t37 and .t37_1. Fix support for the 1m color. Change font-weight to normal for the kbd element, to avoid both the command (like `zig build-exe`) and the first line of the error message having a bold font. Rename the "shell parsed" test to "printShell".
2023-02-25 10:14:43 +00:00
.sgr-31_1m {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: #b40000;
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
}
docgen: improve the termColor function Make the termColor function more robust, ensuring that the generated HTML classes are more consistent and that they are supported in the CSS. Add documentation about the ANSI codes generated by Zig, and remove the previous comment with the supported colors. Improve test coverage for the termColor function, and move the tests at the end of the file before the printShell tests. Rename the "term color" test to "term supported colors" and add an additional "term output from zig" test, using test data generated from the Zig compiler. Update the langref.html.in CSS to use the new names and remove incorrect or obsolete colors like .t0_1, .t37 and .t37_1. Fix support for the 1m color. Change font-weight to normal for the kbd element, to avoid both the command (like `zig build-exe`) and the first line of the error message having a bold font. Rename the "shell parsed" test to "printShell".
2023-02-25 10:14:43 +00:00
.sgr-32_1m {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: green;
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
}
docgen: improve the termColor function Make the termColor function more robust, ensuring that the generated HTML classes are more consistent and that they are supported in the CSS. Add documentation about the ANSI codes generated by Zig, and remove the previous comment with the supported colors. Improve test coverage for the termColor function, and move the tests at the end of the file before the printShell tests. Rename the "term color" test to "term supported colors" and add an additional "term output from zig" test, using test data generated from the Zig compiler. Update the langref.html.in CSS to use the new names and remove incorrect or obsolete colors like .t0_1, .t37 and .t37_1. Fix support for the 1m color. Change font-weight to normal for the kbd element, to avoid both the command (like `zig build-exe`) and the first line of the error message having a bold font. Rename the "shell parsed" test to "printShell".
2023-02-25 10:14:43 +00:00
.sgr-36_1m {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: #005C7A;
}
.file {
font-weight: bold;
border: unset;
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
code {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
background: #f8f8f8;
border: 1px dotted silver;
padding-left: 0.3em;
padding-right: 0.3em;
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
}
Improve documentation styling for mobile devices - No overscrolling on small screens - Font-size is reduced for more content per screen - Tables + Code blocks scroll within a block to avoid page-widenening
2018-01-30 04:33:38 +00:00
pre > code {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
display: block;
overflow: auto;
padding: 0.5em;
border: 1px solid #eee;
line-height: normal;
Make clearer inline code blocks in language reference paragraphs (#9317) * Make clearer inline code blocks in language reference paragraphs This commit makes the inline code blocks within paragraphs standout against the descriptive text. The code blocks within tables are left un-styled. The line-height of the paragraphs has been set to 1.7 based on recommendations from MDN Web Docs and W3C. The value is unitless based on the recommendation. Closes #9316, #6313 * Make clearer inline code blocks in language reference paragraphs Goal: To improve legibility of inline code blocks in the language reference. This commit alters the styles of code HTML elements in paragraphs, unordered lists, ordered lists, tables, and preformatted text elements. Most of the changes here are taken from suggestions from @dbandstra on GitHub in response to a code review. * p, ul, ol, but not #toc are set to the same line-height * p, ul, ol, and table have the same inline code styles * The inline code background color set to match the preformatted code blocks in the light theme and dark theme. The border colors are adjusted as well. * The preformatted code block font size is set to default. The 12pt setting was removed. The line-height of paragraphs is set to 1.5. This value is chosen based on recommendations from W3C [1] via MDN Web Docs [2] and the contents of the language reference. The MDN Web Docs offers two recommendations: 1. Use a unitless number for line-height. 2. Use a minimum value of 1.5 for main paragraph content. [1] https://www.w3.org/TR/WCAG21/#visual-presentation [2] https://developer.mozilla.org/en-US/docs/Web/CSS/line-height Closes #6313, #9316 * Set language reference line-height and pre code border color This commit is an update to a group of commits with the goal of improving the legibility of the language reference. In this commit, the line-height is now set in the `#contents` ID and reset to normal for preformatted code blocks. This change better separates lines of all main content text for legibility. Closes: #9316, #6313 * Style the language reference code elements This commit sets the style of the HTML code element. Since preformatted code blocks have an overriding style, this is safe to set for all inline code elements.
2021-08-20 10:02:14 +00:00
}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
samp {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
background: #fafafa;
Improve documentation styling for mobile devices - No overscrolling on small screens - Font-size is reduced for more content per screen - Tables + Code blocks scroll within a block to avoid page-widenening
2018-01-30 04:33:38 +00:00
}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
pre > samp {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
display: block;
overflow: auto;
padding: 0.5em;
border: 1px solid #eee;
line-height: normal;
}
kbd {
docgen: improve the termColor function Make the termColor function more robust, ensuring that the generated HTML classes are more consistent and that they are supported in the CSS. Add documentation about the ANSI codes generated by Zig, and remove the previous comment with the supported colors. Improve test coverage for the termColor function, and move the tests at the end of the file before the printShell tests. Rename the "term color" test to "term supported colors" and add an additional "term output from zig" test, using test data generated from the Zig compiler. Update the langref.html.in CSS to use the new names and remove incorrect or obsolete colors like .t0_1, .t37 and .t37_1. Fix support for the 1m color. Change font-weight to normal for the kbd element, to avoid both the command (like `zig build-exe`) and the first line of the error message having a bold font. Rename the "shell parsed" test to "printShell".
2023-02-25 10:14:43 +00:00
font-weight: normal;
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
}
.table-wrapper {
width: 100%;
overflow-x: auto;
Improve documentation styling for mobile devices - No overscrolling on small screens - Font-size is reduced for more content per screen - Tables + Code blocks scroll within a block to avoid page-widenening
2018-01-30 04:33:38 +00:00
}
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
docs: langref is now javascript-free
2018-09-12 21:26:51 +00:00
.tok-kw {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: #333;
font-weight: bold;
docs: langref is now javascript-free
2018-09-12 21:26:51 +00:00
}
.tok-str {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: #d14;
docs: langref is now javascript-free
2018-09-12 21:26:51 +00:00
}
.tok-builtin {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: #005C7A;
docs: langref is now javascript-free
2018-09-12 21:26:51 +00:00
}
.tok-comment {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: #545454;
font-style: italic;
docs: langref is now javascript-free
2018-09-12 21:26:51 +00:00
}
.tok-fn {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: #900;
font-weight: bold;
docs: langref is now javascript-free
2018-09-12 21:26:51 +00:00
}
.tok-null {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: #005C5C;
docs: langref is now javascript-free
2018-09-12 21:26:51 +00:00
}
.tok-number {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: #005C5C;
docs: langref is now javascript-free
2018-09-12 21:26:51 +00:00
}
.tok-type {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: #458;
font-weight: bold;
langref table of contents in a separate column on large displays
2019-10-23 10:55:20 +00:00
}
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
figure {
margin: auto 0;
}
figure pre {
margin-top: 0;
}
figcaption {
padding-left: 0.5em;
font-size: small;
border-top-left-radius: 5px;
border-top-right-radius: 5px;
langref: dark style. easier on the eyes
2018-10-24 02:11:31 +00:00
}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
figcaption.zig-cap {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
background: #fcdba5;
}
figcaption.c-cap {
background: #a8b9cc;
color: #000;
langref: rework the theming and layout * Instead of the only color scheme being dark, the language reference now has a light theme by default, and respects the user's light/dark preference via prefers-color-scheme media query. Most browsers don't support this yet, so we just have to wait patiently for the future to arrive. closes #2172. * Instead of a side bar index, the index is inline with the rest of the content. This is simpler and more friendly to all user agents, and means we don't need the media query for mobile devices. It also makes back-references work, so now headers link to the table of contents and the table of contents links to headers.
2019-04-03 21:39:07 +00:00
}
switch back to peg for the grammar type
2021-10-03 20:27:12 +00:00
figcaption.peg-cap {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
background: #fcdba5;
fix grammer file name and .y file type
2021-10-02 20:54:05 +00:00
}
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
figcaption.javascript-cap {
background: #365d95;
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
color: #fff;
langref: dark style. easier on the eyes
2018-10-24 02:11:31 +00:00
}
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
figcaption.shell-cap {
background: #ccc;
color: #000;
}
aside {
border-left: 0.25em solid #f7a41d;
padding: 0 1em 0 1em;
}
h1 a, h2 a, h3 a, h4 a, h5 a {
text-decoration: none;
color: #333;
}
a.hdr {
visibility: hidden;
}
h1:hover > a.hdr, h2:hover > a.hdr, h3:hover > a.hdr, h4:hover > a.hdr, h5:hover > a.hdr {
visibility: visible;
}
th pre code {
background: none;
}
@media (prefers-color-scheme: dark) {
body{
background:#121212;
color: #ccc;
}
a {
color: #88f;
}
a:hover,a:focus {
color: #000;
}
table, th, td {
border-color: grey;
}
docgen: improve the termColor function Make the termColor function more robust, ensuring that the generated HTML classes are more consistent and that they are supported in the CSS. Add documentation about the ANSI codes generated by Zig, and remove the previous comment with the supported colors. Improve test coverage for the termColor function, and move the tests at the end of the file before the printShell tests. Rename the "term color" test to "term supported colors" and add an additional "term output from zig" test, using test data generated from the Zig compiler. Update the langref.html.in CSS to use the new names and remove incorrect or obsolete colors like .t0_1, .t37 and .t37_1. Fix support for the 1m color. Change font-weight to normal for the kbd element, to avoid both the command (like `zig build-exe`) and the first line of the error message having a bold font. Rename the "shell parsed" test to "printShell".
2023-02-25 10:14:43 +00:00
.sgr-2m {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: grey;
}
docgen: improve the termColor function Make the termColor function more robust, ensuring that the generated HTML classes are more consistent and that they are supported in the CSS. Add documentation about the ANSI codes generated by Zig, and remove the previous comment with the supported colors. Improve test coverage for the termColor function, and move the tests at the end of the file before the printShell tests. Rename the "term color" test to "term supported colors" and add an additional "term output from zig" test, using test data generated from the Zig compiler. Update the langref.html.in CSS to use the new names and remove incorrect or obsolete colors like .t0_1, .t37 and .t37_1. Fix support for the 1m color. Change font-weight to normal for the kbd element, to avoid both the command (like `zig build-exe`) and the first line of the error message having a bold font. Rename the "shell parsed" test to "printShell".
2023-02-25 10:14:43 +00:00
.sgr-31_1m {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: red;
}
docgen: improve the termColor function Make the termColor function more robust, ensuring that the generated HTML classes are more consistent and that they are supported in the CSS. Add documentation about the ANSI codes generated by Zig, and remove the previous comment with the supported colors. Improve test coverage for the termColor function, and move the tests at the end of the file before the printShell tests. Rename the "term color" test to "term supported colors" and add an additional "term output from zig" test, using test data generated from the Zig compiler. Update the langref.html.in CSS to use the new names and remove incorrect or obsolete colors like .t0_1, .t37 and .t37_1. Fix support for the 1m color. Change font-weight to normal for the kbd element, to avoid both the command (like `zig build-exe`) and the first line of the error message having a bold font. Rename the "shell parsed" test to "printShell".
2023-02-25 10:14:43 +00:00
.sgr-32_1m {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: #00B800;
}
docgen: improve the termColor function Make the termColor function more robust, ensuring that the generated HTML classes are more consistent and that they are supported in the CSS. Add documentation about the ANSI codes generated by Zig, and remove the previous comment with the supported colors. Improve test coverage for the termColor function, and move the tests at the end of the file before the printShell tests. Rename the "term color" test to "term supported colors" and add an additional "term output from zig" test, using test data generated from the Zig compiler. Update the langref.html.in CSS to use the new names and remove incorrect or obsolete colors like .t0_1, .t37 and .t37_1. Fix support for the 1m color. Change font-weight to normal for the kbd element, to avoid both the command (like `zig build-exe`) and the first line of the error message having a bold font. Rename the "shell parsed" test to "printShell".
2023-02-25 10:14:43 +00:00
.sgr-36_1m {
chore: doc fixes, closes 11091
2022-03-21 20:31:41 +00:00
color: #0086b3;
}
code {
background: #222;
border-color: #444;
}
pre > code {
color: #ccc;
background: #222;
border: unset;
}
samp {
background: #000;
color: #ccc;
}
pre > samp {
border: unset;
}
.tok-kw {
color: #eee;
}
.tok-str {
color: #2e5;
}
.tok-builtin {
color: #ff894c;
}
.tok-comment {
color: #aa7;
}
.tok-fn {
color: #B1A0F8;
}
.tok-null {
color: #ff8080;
}
.tok-number {
color: #ff8080;
}
.tok-type {
color: #68f;
}
h1 a, h2 a, h3 a, h4 a, h5 a {
color: #aaa;
}
figcaption.zig-cap {
background-color: #b27306;
color: #000;
}
figcaption.peg-cap {
background-color: #b27306;
color: #000;
}
figcaption.shell-cap {
background: #2a2a2a;
color: #fff;
}
}
</style>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</head>
<body>
<header><h1>Zig Language Reference</h1></header>
<div id="main-wrapper">
<div id="navigation">
<nav aria-labelledby="zig-version">
<h2 id="zig-version">Zig Version</h2>
<a href="https://ziglang.org/documentation/0.1.1/">0.1.1</a> |
<a href="https://ziglang.org/documentation/0.2.0/">0.2.0</a> |
<a href="https://ziglang.org/documentation/0.3.0/">0.3.0</a> |
<a href="https://ziglang.org/documentation/0.4.0/">0.4.0</a> |
<a href="https://ziglang.org/documentation/0.5.0/">0.5.0</a> |
<a href="https://ziglang.org/documentation/0.6.0/">0.6.0</a> |
<a href="https://ziglang.org/documentation/0.7.1/">0.7.1</a> |
<a href="https://ziglang.org/documentation/0.8.1/">0.8.1</a> |
CI: update download page and langref for 0.9.1
2022-02-15 03:08:04 +00:00
<a href="https://ziglang.org/documentation/0.9.1/">0.9.1</a> |
langref: point 0.10.0 nav link to 0.10.1
2023-01-23 01:19:26 +00:00
<a href="https://ziglang.org/documentation/0.10.1/">0.10.1</a> |
Release 0.11.0
2023-08-03 18:22:03 +00:00
<a href="https://ziglang.org/documentation/0.11.0/">0.11.0</a> |
Release 0.12.0
2024-04-19 21:00:35 +00:00
<a href="https://ziglang.org/documentation/0.12.0/">0.12.0</a> |
Release 0.13.0
2024-06-06 19:05:11 +00:00
<a href="https://ziglang.org/documentation/0.13.0/">0.13.0</a> |
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
master
</nav>
<nav aria-labelledby="table-of-contents">
<h2 id="table-of-contents">Table of Contents</h2>
{#nav#}
</nav>
langref table of contents in a separate column on large displays
2019-10-23 10:55:20 +00:00
</div>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<div id="contents-wrapper"><main id="contents">
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Introduction#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<a href="https://ziglang.org">Zig</a> is a general-purpose programming language and toolchain for maintaining
update readme tagline
2019-12-30 23:16:40 +00:00
<strong>robust</strong>, <strong>optimal</strong>, and <strong>reusable</strong> software.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<dl>
<dt>Robust</dt><dd>Behavior is correct even for edge cases such as out of memory.</dd>
<dt>Optimal</dt><dd>Write programs the best way they can behave and perform.</dd>
<dt>Reusable</dt><dd>The same code works in many environments which have different
constraints.</dd>
<dt>Maintainable</dt><dd>Precisely communicate intent to the compiler and
README: update the short description of what zig is
2019-11-13 18:44:19 +00:00
other programmers. The language imposes a low overhead to reading code and is
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
resilient to changing requirements and environments.</dd>
</dl>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Often the most efficient way to learn something new is to see examples, so
this documentation shows how to use each of Zig's features. It is
all on one page so you can search with your browser's search tool.
</p>
<p>
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
The code samples in this document are compiled and tested as part of the main test suite of Zig.
Explain Language Ref's Hello World To introduce the Zig programming language, the "Hello, world!" code sample now has documentation to explain some of the features shown in the code sample and contains links to those features in the rest of the documentation. Writing style goals: * Balance writing style to keep beginner and experience programmers interested. * Be concise: allow the rest of the documentation to clarify language features.
2020-07-09 11:38:02 +00:00
</p>
<p>
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
This HTML document depends on no external files, so you can use it offline.
</p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
{#header_close#}
{#header_open|Zig Standard Library#}
<p>
The <a href="https://ziglang.org/documentation/master/std/">Zig Standard Library</a> has its own documentation.
</p>
docs: mention the standard library documentation also mention the FAQ in the README. also link to the other documentation versions.
2019-07-02 19:21:03 +00:00
<p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
Zig's Standard Library contains commonly used algorithms, data structures, and definitions to help you build programs or libraries.
You will see many examples of Zig's Standard Library used in this documentation. To learn more about the Zig Standard Library,
visit the link above.
docs: mention the standard library documentation also mention the FAQ in the README. also link to the other documentation versions.
2019-07-02 19:21:03 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
langref: rework the theming and layout * Instead of the only color scheme being dark, the language reference now has a light theme by default, and respects the user's light/dark preference via prefers-color-scheme media query. Most browsers don't support this yet, so we just have to wait patiently for the future to arrive. closes #2172. * Instead of a side bar index, the index is inline with the rest of the content. This is simpler and more friendly to all user agents, and means we don't need the media query for mobile devices. It also makes back-references work, so now headers link to the table of contents and the table of contents links to headers.
2019-04-03 21:39:07 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Hello World#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|hello.zig#}
docgen: support executing exe code examples See #465
2018-01-17 06:50:35 +00:00
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
langref: fix missing word typo
2024-02-05 15:35:00 +00:00
Most of the time, it is more appropriate to write to stderr rather than stdout, and
langref: simplify Hello World section reverts f510f385920b9a22bd1e68839cd4be3eea092e4d
2024-01-21 23:47:18 +00:00
whether or not the message is successfully written to the stream is irrelevant.
For this common case, there is a simpler API:
Explain Language Ref's Hello World To introduce the Zig programming language, the "Hello, world!" code sample now has documentation to explain some of the features shown in the code sample and contains links to those features in the rest of the documentation. Writing style goals: * Balance writing style to keep beginner and experience programmers interested. * Be concise: allow the rest of the documentation to clarify language features.
2020-07-09 11:38:02 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|hello_again.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<p>
langref: simplify Hello World section reverts f510f385920b9a22bd1e68839cd4be3eea092e4d
2024-01-21 23:47:18 +00:00
In this case, the {#syntax#}!{#endsyntax#} may be omitted from the return
type because no errors are returned from the function.
docgen: verify internal links
2018-01-23 04:06:07 +00:00
</p>
Explain Language Ref's Hello World To introduce the Zig programming language, the "Hello, world!" code sample now has documentation to explain some of the features shown in the code sample and contains links to those features in the rest of the documentation. Writing style goals: * Balance writing style to keep beginner and experience programmers interested. * Be concise: allow the rest of the documentation to clarify language features.
2020-07-09 11:38:02 +00:00
{#see_also|Values|@import|Errors|Root Source File|Source Encoding#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
Add "Comments" section to language reference (#1309) The contents of this section come from the discussion on issue #1305.
2018-07-31 02:27:07 +00:00
{#header_open|Comments#}
Langref misc fix and improvement (#14695) * langref: improve the Hello World section Clarify that a Zig source file must have the .zig extension. Fix a typo. * langref: improve the Comments section - Document how doc comments are used by -femit-docs - Rename "Doc comments" to "Doc Comments", for consistency - Clarify that placing a doc comment in an unexpected place is a compiler error and add two incorrect examples - Document the current Autodoc behavior, when normal comments are interleaved with doc comments - Rewrite the documentation for top-level doc comments * langref: improve the Zig Test section Document that the test name can also be an identifier, in addition to a string literal. Update the test output for the first test. Closes #14085
2023-06-17 20:35:50 +00:00
<p>
Zig supports 3 types of comments. Normal comments are ignored, but doc comments
and top-level doc comments are used by the compiler to generate the package documentation.
</p>
<p>
The generated documentation is still experimental, and can be produced with:
</p>
{#shell_samp#}zig test -femit-docs main.zig{#end_shell_samp#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|comments.zig#}
Add "Comments" section to language reference (#1309) The contents of this section come from the discussion on issue #1305.
2018-07-31 02:27:07 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
There are no multiline comments in Zig (e.g. like <code class="c">/* */</code>
Fix Typo in langref.html.in
2023-06-20 18:27:52 +00:00
comments in C). This allows Zig to have the property that each line
Add "Comments" section to language reference (#1309) The contents of this section come from the discussion on issue #1305.
2018-07-31 02:27:07 +00:00
of code can be tokenized out of context.
</p>
Langref misc fix and improvement (#14695) * langref: improve the Hello World section Clarify that a Zig source file must have the .zig extension. Fix a typo. * langref: improve the Comments section - Document how doc comments are used by -femit-docs - Rename "Doc comments" to "Doc Comments", for consistency - Clarify that placing a doc comment in an unexpected place is a compiler error and add two incorrect examples - Document the current Autodoc behavior, when normal comments are interleaved with doc comments - Rewrite the documentation for top-level doc comments * langref: improve the Zig Test section Document that the test name can also be an identifier, in addition to a string literal. Update the test output for the first test. Closes #14085
2023-06-17 20:35:50 +00:00
{#header_open|Doc Comments#}
Add "Comments" section to language reference (#1309) The contents of this section come from the discussion on issue #1305.
2018-07-31 02:27:07 +00:00
<p>
A doc comment is one that begins with exactly three slashes (i.e.
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}///{#endsyntax#} but not {#syntax#}////{#endsyntax#});
Add "Comments" section to language reference (#1309) The contents of this section come from the discussion on issue #1305.
2018-07-31 02:27:07 +00:00
multiple doc comments in a row are merged together to form a multiline
doc comment. The doc comment documents whatever immediately follows it.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|doc_comments.zig#}
Add "Comments" section to language reference (#1309) The contents of this section come from the discussion on issue #1305.
2018-07-31 02:27:07 +00:00
<p>
Langref misc fix and improvement (#14695) * langref: improve the Hello World section Clarify that a Zig source file must have the .zig extension. Fix a typo. * langref: improve the Comments section - Document how doc comments are used by -femit-docs - Rename "Doc comments" to "Doc Comments", for consistency - Clarify that placing a doc comment in an unexpected place is a compiler error and add two incorrect examples - Document the current Autodoc behavior, when normal comments are interleaved with doc comments - Rewrite the documentation for top-level doc comments * langref: improve the Zig Test section Document that the test name can also be an identifier, in addition to a string literal. Update the test output for the first test. Closes #14085
2023-06-17 20:35:50 +00:00
Doc comments are only allowed in certain places; it is a compile error to
have a doc comment in an unexpected place, such as in the middle of an expression,
or just before a non-doc comment.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|invalid_doc-comment.zig#}
{#code|unattached_doc-comment.zig#}
Langref misc fix and improvement (#14695) * langref: improve the Hello World section Clarify that a Zig source file must have the .zig extension. Fix a typo. * langref: improve the Comments section - Document how doc comments are used by -femit-docs - Rename "Doc comments" to "Doc Comments", for consistency - Clarify that placing a doc comment in an unexpected place is a compiler error and add two incorrect examples - Document the current Autodoc behavior, when normal comments are interleaved with doc comments - Rewrite the documentation for top-level doc comments * langref: improve the Zig Test section Document that the test name can also be an identifier, in addition to a string literal. Update the test output for the first test. Closes #14085
2023-06-17 20:35:50 +00:00
<p>
Doc comments can be interleaved with normal comments. Currently, when producing
the package documentation, normal comments are merged with doc comments.
Add "Comments" section to language reference (#1309) The contents of this section come from the discussion on issue #1305.
2018-07-31 02:27:07 +00:00
</p>
{#header_close#}
Document top-level doc comments, per #2288.
2020-07-05 22:39:28 +00:00
{#header_open|Top-Level Doc Comments#}
Langref misc fix and improvement (#14695) * langref: improve the Hello World section Clarify that a Zig source file must have the .zig extension. Fix a typo. * langref: improve the Comments section - Document how doc comments are used by -femit-docs - Rename "Doc comments" to "Doc Comments", for consistency - Clarify that placing a doc comment in an unexpected place is a compiler error and add two incorrect examples - Document the current Autodoc behavior, when normal comments are interleaved with doc comments - Rewrite the documentation for top-level doc comments * langref: improve the Zig Test section Document that the test name can also be an identifier, in addition to a string literal. Update the test output for the first test. Closes #14085
2023-06-17 20:35:50 +00:00
<p>
A top-level doc comment is one that begins with two slashes and an exclamation
point: {#syntax#}//!{#endsyntax#}; it documents the current module.
</p>
<p>
It is a compile error if a top-level doc comment is not placed at the start
of a {#link|container|Containers#}, before any expressions.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|tldoc_comments.zig#}
Langref misc fix and improvement (#14695) * langref: improve the Hello World section Clarify that a Zig source file must have the .zig extension. Fix a typo. * langref: improve the Comments section - Document how doc comments are used by -femit-docs - Rename "Doc comments" to "Doc Comments", for consistency - Clarify that placing a doc comment in an unexpected place is a compiler error and add two incorrect examples - Document the current Autodoc behavior, when normal comments are interleaved with doc comments - Rewrite the documentation for top-level doc comments * langref: improve the Zig Test section Document that the test name can also be an identifier, in addition to a string literal. Update the test output for the first test. Closes #14085
2023-06-17 20:35:50 +00:00
Document top-level doc comments, per #2288.
2020-07-05 22:39:28 +00:00
{#header_close#}
Add "Comments" section to language reference (#1309) The contents of this section come from the discussion on issue #1305.
2018-07-31 02:27:07 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Values#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|values.zig#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Primitive Types#}
Improve documentation styling for mobile devices - No overscrolling on small screens - Font-size is reduced for more content per screen - Tables + Code blocks scroll within a block to avoid page-widenening
2018-01-30 04:33:38 +00:00
<div class="table-wrapper">
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<table>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<caption>Primitive Types</caption>
<thead>
<tr>
<th scope="col">Type</th>
<th scope="col">C Equivalent</th>
<th scope="col">Description</th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</thead>
<tbody>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}i8{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">int8_t</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>signed 8-bit integer</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}u8{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">uint8_t</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>unsigned 8-bit integer</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}i16{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">int16_t</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>signed 16-bit integer</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}u16{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">uint16_t</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>unsigned 16-bit integer</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}i32{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">int32_t</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>signed 32-bit integer</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}u32{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">uint32_t</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>unsigned 32-bit integer</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}i64{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">int64_t</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>signed 64-bit integer</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}u64{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">uint64_t</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>unsigned 64-bit integer</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}i128{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">__int128</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>signed 128-bit integer</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}u128{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">unsigned __int128</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>unsigned 128-bit integer</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}isize{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">intptr_t</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>signed pointer sized integer</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}usize{#endsyntax#}</th>
[doc update] add size_t (#11482) For those souls looking for a zig `size_t` equivalent, and not lucky/educated enough (that was me yesterday) to know it's the same as `uintptr_t`. From a recent discussion on IRC.
2022-04-21 18:33:42 +00:00
<td><code class="c">uintptr_t</code>, <code class="c">size_t</code></td>
<td>unsigned pointer sized integer. Also see <a href="https://github.com/ziglang/zig/issues/5185">#5185</a></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
langref: Add c_char to the list of primitive types
2023-06-28 18:58:45 +00:00
<tr>
<th scope="row">{#syntax#}c_char{#endsyntax#}</th>
<td><code class="c">char</code></td>
<td>for ABI compatibility with C</td>
</tr>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}c_short{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">short</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>for ABI compatibility with C</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}c_ushort{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">unsigned short</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>for ABI compatibility with C</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}c_int{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">int</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>for ABI compatibility with C</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}c_uint{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">unsigned int</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>for ABI compatibility with C</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}c_long{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">long</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>for ABI compatibility with C</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}c_ulong{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">unsigned long</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>for ABI compatibility with C</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}c_longlong{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">long long</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>for ABI compatibility with C</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}c_ulonglong{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">unsigned long long</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>for ABI compatibility with C</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}c_longdouble{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">long double</code></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>for ABI compatibility with C</td>
</tr>
add f16 to langref
2018-06-27 16:59:12 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}f16{#endsyntax#}</th>
minor langref improvements
2018-09-24 17:08:21 +00:00
<td><code class="c">_Float16</code></td>
add f16 to langref
2018-06-27 16:59:12 +00:00
<td>16-bit floating point (10-bit mantissa) IEEE-754-2008 binary16</td>
</tr>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}f32{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">float</code></td>
langref: be clear that float types are always IEEE 754
2018-06-16 23:53:52 +00:00
<td>32-bit floating point (23-bit mantissa) IEEE-754-2008 binary32</td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}f64{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">double</code></td>
langref: be clear that float types are always IEEE 754
2018-06-16 23:53:52 +00:00
<td>64-bit floating point (52-bit mantissa) IEEE-754-2008 binary64</td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
std: add f80 bits
2022-01-19 16:47:51 +00:00
<tr>
<th scope="row">{#syntax#}f80{#endsyntax#}</th>
fix C type corresponding to f80
2024-08-01 16:03:50 +00:00
<td><code class="c">long double</code></td>
Correct f80 description
2022-02-02 13:35:51 +00:00
<td>80-bit floating point (64-bit mantissa) IEEE-754-2008 80-bit extended precision</td>
std: add f80 bits
2022-01-19 16:47:51 +00:00
</tr>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}f128{#endsyntax#}</th>
minor langref improvements
2018-09-24 17:08:21 +00:00
<td><code class="c">_Float128</code></td>
langref: be clear that float types are always IEEE 754
2018-06-16 23:53:52 +00:00
<td>128-bit floating point (112-bit mantissa) IEEE-754-2008 binary128</td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}bool{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td><code class="c">bool</code></td>
<td>{#syntax#}true{#endsyntax#} or {#syntax#}false{#endsyntax#}</td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
stage1, stage2: rename c_void to anyopaque (#10316) zig fmt now replaces c_void with anyopaque to make updating code easy.
2021-12-19 05:24:45 +00:00
<tr>
<th scope="row">{#syntax#}anyopaque{#endsyntax#}</th>
<td><code class="c">void</code></td>
<td>Used for type-erased pointers.</td>
</tr>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}void{#endsyntax#}</th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>(none)</td>
langref: mention `void{}` and empty blocks closes #11112 closes #12496
2022-10-30 23:27:02 +00:00
<td>Always the value {#syntax#}void{}{#endsyntax#}</td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}noreturn{#endsyntax#}</th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>(none)</td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td>the type of {#syntax#}break{#endsyntax#}, {#syntax#}continue{#endsyntax#}, {#syntax#}return{#endsyntax#}, {#syntax#}unreachable{#endsyntax#}, and {#syntax#}while (true) {}{#endsyntax#}</td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}type{#endsyntax#}</th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>(none)</td>
<td>the type of types</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}anyerror{#endsyntax#}</th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>(none)</td>
<td>an error code</td>
</tr>
langref: be clear that float types are always IEEE 754
2018-06-16 23:53:52 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}comptime_int{#endsyntax#}</th>
langref: be clear that float types are always IEEE 754
2018-06-16 23:53:52 +00:00
<td>(none)</td>
<td>Only allowed for {#link|comptime#}-known values. The type of integer literals.</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}comptime_float{#endsyntax#}</th>
langref: be clear that float types are always IEEE 754
2018-06-16 23:53:52 +00:00
<td>(none)</td>
<td>Only allowed for {#link|comptime#}-known values. The type of float literals.</td>
</tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</tbody>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</table>
Improve documentation styling for mobile devices - No overscrolling on small screens - Font-size is reduced for more content per screen - Tables + Code blocks scroll within a block to avoid page-widenening
2018-01-30 04:33:38 +00:00
</div>
document fixed-width integer types closes #1280
2018-08-25 21:39:43 +00:00
<p>
In addition to the integer types above, arbitrary bit-width integers can be referenced by using
docs: add html lang and minor fixes
2019-12-05 21:38:59 +00:00
an identifier of <code>i</code> or <code>u</code> followed by digits. For example, the identifier
limit integer types to maximum bit width of 65535 closes #1541
2018-11-06 16:09:14 +00:00
{#syntax#}i7{#endsyntax#} refers to a signed 7-bit integer. The maximum allowed bit-width of an
integer type is {#syntax#}65535{#endsyntax#}.
document fixed-width integer types closes #1280
2018-08-25 21:39:43 +00:00
</p>
remove uses of `@ArgType` and `@IntType`
2020-02-24 21:39:03 +00:00
{#see_also|Integers|Floats|void|Errors|@Type#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Primitive Values#}
Improve documentation styling for mobile devices - No overscrolling on small screens - Font-size is reduced for more content per screen - Tables + Code blocks scroll within a block to avoid page-widenening
2018-01-30 04:33:38 +00:00
<div class="table-wrapper">
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<table>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<caption>Primitive Values</caption>
<thead>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="col">Name</th>
<th scope="col">Description</th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</thead>
<tbody>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}true{#endsyntax#} and {#syntax#}false{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td>{#syntax#}bool{#endsyntax#} values</td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}null{#endsyntax#}</th>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td>used to set an optional type to {#syntax#}null{#endsyntax#}</td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">{#syntax#}undefined{#endsyntax#}</th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>used to leave a value unspecified</td>
</tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</tbody>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</table>
Improve documentation styling for mobile devices - No overscrolling on small screens - Font-size is reduced for more content per screen - Tables + Code blocks scroll within a block to avoid page-widenening
2018-01-30 04:33:38 +00:00
</div>
minor langref improvements
2018-09-24 17:08:21 +00:00
{#see_also|Optionals|undefined#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
Avoid concept of a "Unicode character" in documentation and error messages (#8059)
2021-02-24 13:26:13 +00:00
{#header_open|String Literals and Unicode Code Point Literals#}
character literals: allow unicode escapes also make the documentation for character literals more clear. closes #2089 see #2097
2019-03-23 21:35:21 +00:00
<p>
langref: Use "single-item pointer" and "many-item pointer" (#8217) These terms give short, descriptive names for the two pointer types which reflect the names used in src/type.zig.
2021-03-13 01:10:55 +00:00
String literals are constant single-item {#link|Pointers#} to null-terminated byte arrays.
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
The type of string literals encodes both the length, and the fact that they are null-terminated,
and thus they can be {#link|coerced|Type Coercion#} to both {#link|Slices#} and
langref: update for sentinel-terminated types
2019-11-24 03:29:12 +00:00
{#link|Null-Terminated Pointers|Sentinel-Terminated Pointers#}.
Revert "langref: emphasize the use of dereferencing string literals" This reverts commit 27353bb936a161e6a09f1424ce38bf84e78e94e4. * unnecessary example * poor phrasing (avoid "you")
2024-01-21 23:36:27 +00:00
Dereferencing string literals converts them to {#link|Arrays#}.
character literals: allow unicode escapes also make the documentation for character literals more clear. closes #2089 see #2097
2019-03-23 21:35:21 +00:00
</p>
<p>
langref: reduce verbosity of string literal section
2024-01-22 00:14:31 +00:00
Because Zig source code is {#link|UTF-8 encoded|Source Encoding#}, any
non-ASCII bytes appearing within a string literal in source code carry
their UTF-8 meaning into the content of the string in the Zig program;
the bytes are not modified by the compiler. It is possible to embed
non-UTF-8 bytes into a string literal using <code>\xNN</code> notation.
langref: add paragraph and examples about indexing non-ASCII strings PR #10610 addressed most of the points from #1854. This additional paragraph and examples covers the OMISSIONS section clarifying issues about indexing into non-ASCII strings (whether valid UTF-8 or not). I think this finally closes #1854.
2023-01-27 18:29:28 +00:00
</p>
langref: reduce verbosity of string literal section
2024-01-22 00:14:31 +00:00
<p>Indexing into a string containing non-ASCII bytes returns individual
bytes, whether valid UTF-8 or not.</p>
langref: add paragraph and examples about indexing non-ASCII strings PR #10610 addressed most of the points from #1854. This additional paragraph and examples covers the OMISSIONS section clarifying issues about indexing into non-ASCII strings (whether valid UTF-8 or not). I think this finally closes #1854.
2023-01-27 18:29:28 +00:00
<p>
Avoid concept of a "Unicode character" in documentation and error messages (#8059)
2021-02-24 13:26:13 +00:00
Unicode code point literals have type {#syntax#}comptime_int{#endsyntax#}, the same as
character literals: allow unicode escapes also make the documentation for character literals more clear. closes #2089 see #2097
2019-03-23 21:35:21 +00:00
{#link|Integer Literals#}. All {#link|Escape Sequences#} are valid in both string literals
Avoid concept of a "Unicode character" in documentation and error messages (#8059)
2021-02-24 13:26:13 +00:00
and Unicode code point literals.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|string_literals.zig#}
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
{#see_also|Arrays|Source Encoding#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Escape Sequences#}
Improve documentation styling for mobile devices - No overscrolling on small screens - Font-size is reduced for more content per screen - Tables + Code blocks scroll within a block to avoid page-widenening
2018-01-30 04:33:38 +00:00
<div class="table-wrapper">
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<table>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<caption>Escape Sequences</caption>
<thead>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="col">Escape Sequence</th>
<th scope="col">Name</th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</thead>
<tbody>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row"><code>\n</code></th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>Newline</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row"><code>\r</code></th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>Carriage Return</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row"><code>\t</code></th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>Tab</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row"><code>\\</code></th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>Backslash</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row"><code>\'</code></th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>Single Quote</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row"><code>\"</code></th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>Double Quote</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row"><code>\xNN</code></th>
Avoid concept of a "Unicode character" in documentation and error messages (#8059)
2021-02-24 13:26:13 +00:00
<td>hexadecimal 8-bit byte value (2 digits)</td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row"><code>\u{NNNNNN}</code></th>
More precise error message for unencodable `\u` escapes The surrogate code points U+D800 to U+DFFF are valid code points but are not Unicode scalar values. This commit makes the error message more accurately reflect what is actually allowed in `\u` escape sequences. From https://www.unicode.org/versions/Unicode15.0.0/ch03.pdf: > D71 High-surrogate code point: A Unicode code point in the range U+D800 to U+DBFF. > D73 Low-surrogate code point: A Unicode code point in the range U+DC00 to U+DFFF. > > 3.9 Unicode Encoding Forms > D76 Unicode scalar value: Any Unicode code point except high-surrogate and low-surrogate code points. Related: #20270
2024-06-12 05:13:22 +00:00
<td>hexadecimal Unicode scalar value UTF-8 encoded (1 or more digits)</td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</tbody>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</table>
Improve documentation styling for mobile devices - No overscrolling on small screens - Font-size is reduced for more content per screen - Tables + Code blocks scroll within a block to avoid page-widenening
2018-01-30 04:33:38 +00:00
</div>
More precise error message for unencodable `\u` escapes The surrogate code points U+D800 to U+DFFF are valid code points but are not Unicode scalar values. This commit makes the error message more accurately reflect what is actually allowed in `\u` escape sequences. From https://www.unicode.org/versions/Unicode15.0.0/ch03.pdf: > D71 High-surrogate code point: A Unicode code point in the range U+D800 to U+DBFF. > D73 Low-surrogate code point: A Unicode code point in the range U+DC00 to U+DFFF. > > 3.9 Unicode Encoding Forms > D76 Unicode scalar value: Any Unicode code point except high-surrogate and low-surrogate code points. Related: #20270
2024-06-12 05:13:22 +00:00
<p>Note that the maximum valid Unicode scalar value is {#syntax#}0x10ffff{#endsyntax#}.</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Multiline String Literals#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Multiline string literals have no escapes and can span across multiple lines.
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
To start a multiline string literal, use the {#syntax#}\\{#endsyntax#} token. Just like a comment,
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
the string literal goes until the end of the line. The end of the line is
not included in the string literal.
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
However, if the next line begins with {#syntax#}\\{#endsyntax#} then a newline is appended and
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
the string literal continues.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|multiline_string_literals.zig#}
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|@embedFile#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_close#}
{#header_open|Assignment#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>Use the {#syntax#}const{#endsyntax#} keyword to assign a value to an identifier:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|constant_identifier_cannot_change.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>{#syntax#}const{#endsyntax#} applies to all of the bytes that the identifier immediately addresses. {#link|Pointers#} have their own const-ness.</p>
<p>If you need a variable that you can modify, use the {#syntax#}var{#endsyntax#} keyword:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|mutable_var.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>Variables must be initialized:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|var_must_be_initialized.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
{#header_open|undefined#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>Use {#syntax#}undefined{#endsyntax#} to leave variables uninitialized:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|assign_undefined.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
<p>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
{#syntax#}undefined{#endsyntax#} can be {#link|coerced|Type Coercion#} to any type.
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Once this happens, it is no longer possible to detect that the value is {#syntax#}undefined{#endsyntax#}.
{#syntax#}undefined{#endsyntax#} means the value could be anything, even something that is nonsense
according to the type. Translated into English, {#syntax#}undefined{#endsyntax#} means "Not a meaningful
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
value. Using this value would be a bug. The value will be unused, or overwritten before being used."
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
In {#link|Debug#} mode, Zig writes {#syntax#}0xaa{#endsyntax#} bytes to undefined memory. This is to catch
Fix #12822: Clarify langref about the behavior of undefined
2022-09-12 18:13:48 +00:00
bugs early, and to help detect use of undefined memory in a debugger. However, this behavior is only an
implementation feature, not a language semantic, so it is not guaranteed to be observable to code.
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_close#}
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
{#header_close#}
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
{#header_open|Zig Test#}
<p>
Code written within one or more {#syntax#}test{#endsyntax#} declarations can be used to ensure behavior meets expectations:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|testing_introduction.zig#}
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
<p>
Change outdated filename in langref
2023-06-16 19:06:52 +00:00
The <code class="file">testing_introduction.zig</code> code sample tests the {#link|function|Functions#}
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
{#syntax#}addOne{#endsyntax#} to ensure that it returns {#syntax#}42{#endsyntax#} given the input
{#syntax#}41{#endsyntax#}. From this test's perspective, the {#syntax#}addOne{#endsyntax#} function is
said to be <em>code under test</em>.
</p>
<p>
<kbd>zig test</kbd> is a tool that creates and runs a test build. By default, it builds and runs an
executable program using the <em>default test runner</em> provided by the {#link|Zig Standard Library#}
as its main entry point. During the build, {#syntax#}test{#endsyntax#} declarations found while
{#link|resolving|Root Source File#} the given Zig source file are included for the default test runner
to run and report on.
</p>
<aside>
This documentation discusses the features of the default test runner as provided by the Zig Standard Library.
langref: correct test runner path
2024-06-27 19:37:44 +00:00
Its source code is located in <code class="file">lib/compiler/test_runner.zig</code>.
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
</aside>
<p>
The shell output shown above displays two lines after the <kbd>zig test</kbd> command. These lines are
printed to standard error by the default test runner:
</p>
<dl>
test: rework how filtering works * make test names contain the fully qualified name * make test filters match the fully qualified name * allow multiple test filters, where a test is skipped if it does not match any of the specified filters
2024-02-25 13:04:06 +00:00
<dt><samp>1/2 testing_introduction.test.expect addOne adds one to 41...</samp></dt>
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
<dd>Lines like this indicate which test, out of the total number of tests, is being run.
test: rework how filtering works * make test names contain the fully qualified name * make test filters match the fully qualified name * allow multiple test filters, where a test is skipped if it does not match any of the specified filters
2024-02-25 13:04:06 +00:00
In this case, <samp>1/2</samp> indicates that the first test, out of a total of two tests,
is being run. Note that, when the test runner program's standard error is output
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
to the terminal, these lines are cleared when a test succeeds.
</dd>
test: rework how filtering works * make test names contain the fully qualified name * make test filters match the fully qualified name * allow multiple test filters, where a test is skipped if it does not match any of the specified filters
2024-02-25 13:04:06 +00:00
<dt><samp>2/2 testing_introduction.decltest.addOne...</samp></dt>
Langref misc fix and improvement (#14695) * langref: improve the Hello World section Clarify that a Zig source file must have the .zig extension. Fix a typo. * langref: improve the Comments section - Document how doc comments are used by -femit-docs - Rename "Doc comments" to "Doc Comments", for consistency - Clarify that placing a doc comment in an unexpected place is a compiler error and add two incorrect examples - Document the current Autodoc behavior, when normal comments are interleaved with doc comments - Rewrite the documentation for top-level doc comments * langref: improve the Zig Test section Document that the test name can also be an identifier, in addition to a string literal. Update the test output for the first test. Closes #14085
2023-06-17 20:35:50 +00:00
<dd>When the test name is an identifier, the default test runner uses the text
decltest instead of test.
</dd>
<dt><samp>All 2 tests passed.</samp></dt>
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
<dd>This line indicates the total number of tests that have passed.</dd>
</dl>
{#header_open|Test Declarations#}
<p>
Test declarations contain the {#link|keyword|Keyword Reference#} {#syntax#}test{#endsyntax#}, followed by an
Langref misc fix and improvement (#14695) * langref: improve the Hello World section Clarify that a Zig source file must have the .zig extension. Fix a typo. * langref: improve the Comments section - Document how doc comments are used by -femit-docs - Rename "Doc comments" to "Doc Comments", for consistency - Clarify that placing a doc comment in an unexpected place is a compiler error and add two incorrect examples - Document the current Autodoc behavior, when normal comments are interleaved with doc comments - Rewrite the documentation for top-level doc comments * langref: improve the Zig Test section Document that the test name can also be an identifier, in addition to a string literal. Update the test output for the first test. Closes #14085
2023-06-17 20:35:50 +00:00
optional name written as a {#link|string literal|String Literals and Unicode Code Point Literals#} or an
{#link|identifier|Identifiers#}, followed by a {#link|block|Blocks#} containing any valid Zig code that
is allowed in a {#link|function|Functions#}.
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
</p>
langref: extract code comments into paragraphs Related #18496
2024-01-19 04:55:44 +00:00
<p>Non-named test blocks always run during test builds and are exempt from
{#link|Skip Tests#}.</p>
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
<p>
Test declarations are similar to {#link|Functions#}: they have a return type and a block of code. The implicit
return type of {#syntax#}test{#endsyntax#} is the {#link|Error Union Type#} {#syntax#}anyerror!void{#endsyntax#},
and it cannot be changed. When a Zig source file is not built using the <kbd>zig test</kbd> tool, the test
declarations are omitted from the build.
</p>
<p>
Test declarations can be written in the same file, where code under test is written, or in a separate Zig source file.
Since test declarations are top-level declarations, they are order-independent and can
be written before or after the code under test.
</p>
{#see_also|The Global Error Set|Grammar#}
langref: add information about doctests This creates a section in the language reference about doctests, which is currently referenced by Autodoc in a tooltip when displaying a doctest. Some advice relevant to writing doctests is included, based on the discussion on #16472.
2023-12-29 02:00:32 +00:00
{#header_open|Doctests#}
<p>
Test declarations named using an identifier are <em>doctests</em>. The identifier must refer to another declaration in
scope. A doctest, like a {#link|doc comment|Doc Comments#}, serves as documentation for the associated declaration, and
will appear in the generated documentation for the declaration.
</p>
<p>
An effective doctest should be self-contained and focused on the declaration being tested, answering questions a new
user might have about its interface or intended usage, while avoiding unnecessary or confusing details. A doctest is not
a substitute for a doc comment, but rather a supplement and companion providing a testable, code-driven example, verified
by <kbd>zig test</kbd>.
</p>
{#header_close#}
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
{#header_close#}
{#header_open|Test Failure#}
<p>
The default test runner checks for an {#link|error|Errors#} returned from a test.
When a test returns an error, the test is considered a failure and its {#link|error return trace|Error Return Traces#}
is output to standard error. The total number of failures will be reported after all tests have run.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|testing_failure.zig#}
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
{#header_close#}
{#header_open|Skip Tests#}
<p>
One way to skip tests is to filter them out by using the <kbd>zig test</kbd> command line parameter
<kbd>--test-filter [text]</kbd>. This makes the test build only include tests whose name contains the
supplied filter text. Note that non-named tests are run even when using the <kbd>--test-filter [text]</kbd>
command line parameter.
</p>
<p>
To programmatically skip a test, make a {#syntax#}test{#endsyntax#} return the error
{#syntax#}error.SkipZigTest{#endsyntax#} and the default test runner will consider the test as being skipped.
The total number of skipped tests will be reported after all tests have run.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|testing_skip.zig#}
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
{#header_close#}
langref: eliminate dependencies on stage1 This commit removes async/await/suspend/resume from the language reference, as that feature does not yet work in the self-hosted compiler. We will be regressing this feature temporarily. Users of these language features should stick with 0.10.x with the `-fstage1` flag until they are restored. See tracking issue #6025.
2022-12-01 22:28:44 +00:00
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
{#header_open|Report Memory Leaks#}
<p>
When code allocates {#link|Memory#} using the {#link|Zig Standard Library#}'s testing allocator,
{#syntax#}std.testing.allocator{#endsyntax#}, the default test runner will report any leaks that are
found from using the testing allocator:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|testing_detect_leak.zig#}
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
{#see_also|defer|Memory#}
{#header_close#}
{#header_open|Detecting Test Build#}
<p>
Use the {#link|compile variable|Compile Variables#} {#syntax#}@import("builtin").is_test{#endsyntax#}
to detect a test build:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|testing_detect_test.zig#}
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
{#header_close#}
{#header_open|Test Output and Logging#}
<p>
The default test runner and the Zig Standard Library's testing namespace output messages to standard error.
</p>
{#header_close#}
{#header_open|The Testing Namespace#}
<p>
The Zig Standard Library's <code>testing</code> namespace contains useful functions to help
you create tests. In addition to the <code>expect</code> function, this document uses a couple of more functions
as exemplified here:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|testing_namespace.zig#}
langref: Explain Zig Test Updates the Language Reference sections: Comments, Values, and Zig Test. Zig Test section moved down with the goal "make sure it can be read top to bottom sensibly" in mind (issue #1524). Comments and Values section examples changed test declarations to a main function and expect statement to print statements. A print statement was added to the "String Literals and Unicode Code Point" section's example to demonstrate the "u" format specifier. Zig Test Section: * Addresses the question: "How does the syntax work?". * Partially answers the question: "What can I do with the zig test tool?" but should be sufficient to understand the examples in all of this document. * Addresses the question: "How does a top-level test block differ from a function definition?" * Provides a example to run multiple test. Lacks clear definitions of containers, top-level, order independence, lazy analysis, resolve, reference. GitHub Issues: #8221, #8234
2021-09-29 04:31:41 +00:00
<p>The Zig Standard Library also contains functions to compare {#link|Slices#}, strings, and more. See the rest of the
{#syntax#}std.testing{#endsyntax#} namespace in the {#link|Zig Standard Library#} for more available functions.</p>
{#header_close#}
{#header_open|Test Tool Documentation#}
<p>
<kbd>zig test</kbd> has a few command line parameters which affect the compilation.
See <kbd>zig test --help</kbd> for a full list.
</p>
{#header_close#}
{#header_close#}
docs: add Variables section closes #1927
2019-04-04 16:26:47 +00:00
{#header_open|Variables#}
<p>
A variable is a unit of {#link|Memory#} storage.
</p>
<p>
It is generally preferable to use {#syntax#}const{#endsyntax#} rather than
{#syntax#}var{#endsyntax#} when declaring a variable. This causes less work for both
humans and computers to do when reading code, and creates more optimization opportunities.
</p>
Move the paragraph to under variables
2024-01-16 17:11:34 +00:00
<p>
The {#syntax#}extern{#endsyntax#} keyword or {#link|@extern#} builtin function can be used to link against a variable that is exported
from another object. The {#syntax#}export{#endsyntax#} keyword or {#link|@export#} builtin function
can be used to make a variable available to other objects at link time. In both cases,
the type of the variable must be C ABI compatible.
</p>
{#see_also|Exporting a C Library#}
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
{#header_open|Identifiers#}
<p>
Variable identifiers are never allowed to shadow identifiers from an outer scope.
</p>
<p>
Identifiers must start with an alphabetic character or underscore and may be followed
by any number of alphanumeric characters or underscores.
They must not overlap with any keywords. See {#link|Keyword Reference#}.
</p>
<p>
If a name that does not fit these requirements is needed, such as for linking with external libraries, the {#syntax#}@""{#endsyntax#} syntax may be used.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|identifiers.zig#}
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
{#header_close#}
Docs clarification: local static variable (#8381)
2021-06-23 05:45:36 +00:00
{#header_open|Container Level Variables#}
docs: add Variables section closes #1927
2019-04-04 16:26:47 +00:00
<p>
langref: add appendix and explain 'container' terminology
2022-11-09 08:29:50 +00:00
{#link|Container|Containers#} level variables have static lifetime and are order-independent and lazily analyzed.
Docs clarification: local static variable (#8381)
2021-06-23 05:45:36 +00:00
The initialization value of container level variables is implicitly
{#link|comptime#}. If a container level variable is {#syntax#}const{#endsyntax#} then its value is
docs: add Variables section closes #1927
2019-04-04 16:26:47 +00:00
{#syntax#}comptime{#endsyntax#}-known, otherwise it is runtime-known.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_container_level_variables.zig#}
docs: add Variables section closes #1927
2019-04-04 16:26:47 +00:00
<p>
langref: add appendix and explain 'container' terminology
2022-11-09 08:29:50 +00:00
Container level variables may be declared inside a {#link|struct#}, {#link|union#}, {#link|enum#}, or {#link|opaque#}:
docs: add Variables section closes #1927
2019-04-04 16:26:47 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_namespaced_container_level_variable.zig#}
Docs clarification: local static variable (#8381)
2021-06-23 05:45:36 +00:00
{#header_close#}
{#header_open|Static Local Variables#}
<p>
It is also possible to have local variables with static lifetime by using containers inside functions.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_static_local_variable.zig#}
Fix indentation in langref.html.in
2021-07-08 01:50:57 +00:00
docs: add Variables section closes #1927
2019-04-04 16:26:47 +00:00
{#header_close#}
{#header_open|Thread Local Variables#}
<p>A variable may be specified to be a thread-local variable using the
Improvements to docs and text * docs(std.math): elaborate on difference between absCast and absInt * docs(std.rand.Random.weightedIndex): elaborate on likelihood I think this makes it easier to understand. * langref: add small reminder * docs(std.fs.path.extension): brevity * docs(std.bit_set.StaticBitSet): mention the specific types * std.debug.TTY: explain what purpose this struct serves This should also make it clearer that this struct is not supposed to provide unrelated terminal manipulation functionality such as setting the cursor position or something because terminals are complicated and we should keep this struct simple and focused on debugging. * langref(package listing): brevity * langref: explain what exactly `threadlocal` causes to happen * std.array_list: link between swapRemove and orderedRemove Maybe this can serve as a TLDR and make it easier to decide. * PrefetchOptions.locality: clarify docs that this is a range This confused me previously and I thought I can only use either 0 or 3. * fix typos and more * std.builtin.CallingConvention: document some CCs * langref: explain possibly cryptic names I think it helps knowing what exactly these acronyms (@clz and @ctz) and abbreviations (@popCount) mean. * variadic function error: add missing preposition * std.fmt.format docs: nicely hyphenate * help menu: say what to optimize for I think this is slightly more specific than just calling it "optimizations". These are speed optimizations. I used the word "performance" here.
2023-04-23 18:06:21 +00:00
{#syntax#}threadlocal{#endsyntax#} keyword,
which makes each thread work with a separate instance of the variable:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_thread_local_variables.zig#}
docs: add Variables section closes #1927
2019-04-04 16:26:47 +00:00
<p>
Docs clarification: local static variable (#8381)
2021-06-23 05:45:36 +00:00
For {#link|Single Threaded Builds#}, all thread local variables are treated as regular {#link|Container Level Variables#}.
docs: add Variables section closes #1927
2019-04-04 16:26:47 +00:00
</p>
<p>
Thread local variables may not be {#syntax#}const{#endsyntax#}.
</p>
{#header_close#}
{#header_open|Local Variables#}
<p>
Local variables occur inside {#link|Functions#}, {#link|comptime#} blocks, and {#link|@cImport#} blocks.
</p>
<p>
When a local variable is {#syntax#}const{#endsyntax#}, it means that after initialization, the variable's
value will not change. If the initialization value of a {#syntax#}const{#endsyntax#} variable is
{#link|comptime#}-known, then the variable is also {#syntax#}comptime{#endsyntax#}-known.
</p>
<p>
A local variable may be qualified with the {#syntax#}comptime{#endsyntax#} keyword. This causes
the variable's value to be {#syntax#}comptime{#endsyntax#}-known, and all loads and stores of the
variable to happen during semantic analysis of the program, rather than at runtime.
All variables declared in a {#syntax#}comptime{#endsyntax#} expression are implicitly
{#syntax#}comptime{#endsyntax#} variables.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_variables.zig#}
docs: add Variables section closes #1927
2019-04-04 16:26:47 +00:00
{#header_close#}
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Integers#}
{#header_open|Integer Literals#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|integer_literals.zig#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Runtime Integer Values#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Integer literals have no size limitation, and if any undefined behavior occurs,
the compiler catches it.
</p>
<p>
However, once an integer value is no longer known at compile-time, it must have a
known size, and is vulnerable to undefined behavior.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_vs_comptime.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
In this function, values {#syntax#}a{#endsyntax#} and {#syntax#}b{#endsyntax#} are known only at runtime,
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
and thus this division operation is vulnerable to both {#link|Integer Overflow#} and
{#link|Division by Zero#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Operators such as {#syntax#}+{#endsyntax#} and {#syntax#}-{#endsyntax#} cause undefined behavior on
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
integer overflow. Alternative operators are provided for wrapping and saturating arithmetic on all targets.
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
{#syntax#}+%{#endsyntax#} and {#syntax#}-%{#endsyntax#} perform wrapping arithmetic
while {#syntax#}+|{#endsyntax#} and {#syntax#}-|{#endsyntax#} perform saturating arithmetic.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
<p>
Zig supports arbitrary bit-width integers, referenced by using
docs: add html lang and minor fixes
2019-12-05 21:38:59 +00:00
an identifier of <code>i</code> or <code>u</code> followed by digits. For example, the identifier
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
{#syntax#}i7{#endsyntax#} refers to a signed 7-bit integer. The maximum allowed bit-width of an
lagnref: add signed integer repr documentation Closes #11103
2022-08-22 10:57:51 +00:00
integer type is {#syntax#}65535{#endsyntax#}. For signed integer types, Zig uses a
<a href="https://en.wikipedia.org/wiki/Two's_complement">two's complement</a> representation.
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
</p>
{#see_also|Wrapping Operations#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_close#}
{#header_open|Floats#}
langref: be clear that float types are always IEEE 754
2018-06-16 23:53:52 +00:00
<p>Zig has the following floating point types:</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>{#syntax#}f16{#endsyntax#} - IEEE-754-2008 binary16</li>
<li>{#syntax#}f32{#endsyntax#} - IEEE-754-2008 binary32</li>
<li>{#syntax#}f64{#endsyntax#} - IEEE-754-2008 binary64</li>
std: add f80 bits
2022-01-19 16:47:51 +00:00
<li>{#syntax#}f80{#endsyntax#} - IEEE-754-2008 80-bit extended precision</li>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>{#syntax#}f128{#endsyntax#} - IEEE-754-2008 binary128</li>
<li>{#syntax#}c_longdouble{#endsyntax#} - matches <code class="c">long double</code> for the target C ABI</li>
langref: be clear that float types are always IEEE 754
2018-06-16 23:53:52 +00:00
</ul>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Float Literals#}
langref: be clear that float types are always IEEE 754
2018-06-16 23:53:52 +00:00
<p>
docs: clarify NaN, inf, -inf closes #2089
2019-03-23 19:25:38 +00:00
Float literals have type {#syntax#}comptime_float{#endsyntax#} which is guaranteed to have
the same precision and operations of the largest other floating point type, which is
{#syntax#}f128{#endsyntax#}.
</p>
<p>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
Float literals {#link|coerce|Type Coercion#} to any floating point type,
docs: clarify NaN, inf, -inf closes #2089
2019-03-23 19:25:38 +00:00
and to any {#link|integer|Integers#} type when there is no fractional component.
langref: be clear that float types are always IEEE 754
2018-06-16 23:53:52 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|float_literals.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docs: clarify NaN, inf, -inf closes #2089
2019-03-23 19:25:38 +00:00
<p>
There is no syntax for NaN, infinity, or negative infinity. For these special values,
one must use the standard library:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|float_special_values.zig#}
docs: clarify NaN, inf, -inf closes #2089
2019-03-23 19:25:38 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Floating Point Operations#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>By default floating point operations use {#syntax#}Strict{#endsyntax#} mode,
but you can switch to {#syntax#}Optimized{#endsyntax#} mode on a per-block basis:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|float_mode_obj.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
<p>For this test we have to separate code into two object files -
otherwise the optimizer figures out all the values at compile-time,
which operates in strict mode.</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|float_mode_exe.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|@setFloatMode|Division by Zero#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docgen: verify internal links
2018-01-23 04:06:07 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Operators#}
docs: add comment about operator overloading
2018-10-05 22:25:20 +00:00
<p>
There is no operator overloading. When you see an operator in Zig, you know that
it is doing something from this table, and nothing else.
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Table of Operators#}
Improve documentation styling for mobile devices - No overscrolling on small screens - Font-size is reduced for more content per screen - Tables + Code blocks scroll within a block to avoid page-widenening
2018-01-30 04:33:38 +00:00
<div class="table-wrapper">
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<table>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<thead>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<th scope="col">Name</th>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="col">Syntax</th>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<th scope="col">Types</th>
<th scope="col">Remarks</th>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="col">Example</th>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</thead>
<tbody>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Addition</td>
<td><pre>{#syntax#}a + b
a += b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
<li>{#link|Floats#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>Can cause {#link|overflow|Default Operations#} for integers.</li>
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
<li>Invokes {#link|Peer Type Resolution#} for the operands.</li>
<li>See also {#link|@addWithOverflow#}.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}2 + 5 == 7{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Wrapping Addition</td>
<td><pre>{#syntax#}a +% b
a +%= b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<li>Twos-complement wrapping behavior.</li>
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
<li>Invokes {#link|Peer Type Resolution#} for the operands.</li>
doc: @addWithOverflow also returns if overflow occured
2018-08-07 05:10:29 +00:00
<li>See also {#link|@addWithOverflow#}.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<pre>{#syntax#}@as(u32, 0xffffffff) +% 1 == 0{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Saturating Addition</td>
<td><pre>{#syntax#}a +| b
a +|= b{#endsyntax#}</pre></td>
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
<td>
<ul>
<li>{#link|Integers#}</li>
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
<ul>
<li>Invokes {#link|Peer Type Resolution#} for the operands.</li>
</ul>
</td>
<td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<pre>{#syntax#}@as(u8, 255) +| 1 == @as(u8, 255){#endsyntax#}</pre>
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
</td>
</tr>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Subtraction</td>
<td><pre>{#syntax#}a - b
a -= b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
<li>{#link|Floats#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>Can cause {#link|overflow|Default Operations#} for integers.</li>
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
<li>Invokes {#link|Peer Type Resolution#} for the operands.</li>
<li>See also {#link|@subWithOverflow#}.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}2 - 5 == -3{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Wrapping Subtraction</td>
<td><pre>{#syntax#}a -% b
a -%= b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<li>Twos-complement wrapping behavior.</li>
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
<li>Invokes {#link|Peer Type Resolution#} for the operands.</li>
<li>See also {#link|@subWithOverflow#}.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<pre>{#syntax#}@as(u8, 0) -% 1 == 255{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Saturating Subtraction</td>
<td><pre>{#syntax#}a -| b
a -|= b{#endsyntax#}</pre></td>
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
<td>
<ul>
<li>{#link|Integers#}</li>
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
<ul>
<li>Invokes {#link|Peer Type Resolution#} for the operands.</li>
</ul>
</td>
<td>
<pre>{#syntax#}@as(u32, 0) -| 1 == 0{#endsyntax#}</pre>
</td>
</tr>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Negation</td>
<td><pre>{#syntax#}-a{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
<li>{#link|Floats#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>Can cause {#link|overflow|Default Operations#} for integers.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}-1 == 0 - 1{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Wrapping Negation</td>
<td><pre>{#syntax#}-%a{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
<ul>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<li>Twos-complement wrapping behavior.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
Fix doc - Language Reference - Table of Operators
2024-03-04 09:15:57 +00:00
<pre>{#syntax#}-%@as(i8, -128) == -128{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Multiplication</td>
<td><pre>{#syntax#}a * b
a *= b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
<li>{#link|Floats#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>Can cause {#link|overflow|Default Operations#} for integers.</li>
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
<li>Invokes {#link|Peer Type Resolution#} for the operands.</li>
<li>See also {#link|@mulWithOverflow#}.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}2 * 5 == 10{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Wrapping Multiplication</td>
<td><pre>{#syntax#}a *% b
a *%= b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<li>Twos-complement wrapping behavior.</li>
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
<li>Invokes {#link|Peer Type Resolution#} for the operands.</li>
<li>See also {#link|@mulWithOverflow#}.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
Update the docs to use `@as`
2019-12-03 10:56:50 +00:00
<pre>{#syntax#}@as(u8, 200) *% 2 == 144{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Saturating Multiplication</td>
<td><pre>{#syntax#}a *| b
a *|= b{#endsyntax#}</pre></td>
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
<td>
<ul>
<li>{#link|Integers#}</li>
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
<ul>
<li>Invokes {#link|Peer Type Resolution#} for the operands.</li>
</ul>
</td>
<td>
<pre>{#syntax#}@as(u8, 200) *| 2 == 255{#endsyntax#}</pre>
</td>
</tr>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Division</td>
<td><pre>{#syntax#}a / b
a /= b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
<li>{#link|Floats#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>Can cause {#link|overflow|Default Operations#} for integers.</li>
<li>Can cause {#link|Division by Zero#} for integers.</li>
<li>Can cause {#link|Division by Zero#} for floats in {#link|FloatMode.Optimized Mode|Floating Point Operations#}.</li>
Clarify condusing wording regarding `%` and `/` Previous wording made it seem like any signed or floating-point value would be allowed at comptime, whereas negative values do not work with `%`, and negative integers do not work with `/`.
2020-12-18 13:04:03 +00:00
<li>Signed integer operands must be comptime-known and positive. In other cases, use
docgen: verify internal links
2018-01-23 04:06:07 +00:00
{#link|@divTrunc#},
{#link|@divFloor#}, or
Clarify condusing wording regarding `%` and `/` Previous wording made it seem like any signed or floating-point value would be allowed at comptime, whereas negative values do not work with `%`, and negative integers do not work with `/`.
2020-12-18 13:04:03 +00:00
{#link|@divExact#} instead.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</li>
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
<li>Invokes {#link|Peer Type Resolution#} for the operands.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}10 / 5 == 2{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Remainder Division</td>
<td><pre>{#syntax#}a % b
a %= b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
<li>{#link|Floats#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>Can cause {#link|Division by Zero#} for integers.</li>
<li>Can cause {#link|Division by Zero#} for floats in {#link|FloatMode.Optimized Mode|Floating Point Operations#}.</li>
Clarify condusing wording regarding `%` and `/` Previous wording made it seem like any signed or floating-point value would be allowed at comptime, whereas negative values do not work with `%`, and negative integers do not work with `/`.
2020-12-18 13:04:03 +00:00
<li>Signed or floating-point operands must be comptime-known and positive. In other cases, use
docgen: verify internal links
2018-01-23 04:06:07 +00:00
{#link|@rem#} or
Clarify condusing wording regarding `%` and `/` Previous wording made it seem like any signed or floating-point value would be allowed at comptime, whereas negative values do not work with `%`, and negative integers do not work with `/`.
2020-12-18 13:04:03 +00:00
{#link|@mod#} instead.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</li>
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
<li>Invokes {#link|Peer Type Resolution#} for the operands.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}10 % 3 == 1{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Bit Shift Left</td>
<td><pre>{#syntax#}a << b
a <<= b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<li>Moves all bits to the left, inserting new zeroes at the
least-significant bit.</li>
<li>{#syntax#}b{#endsyntax#} must be
{#link|comptime-known|comptime#} or have a type with log2 number
of bits as {#syntax#}a{#endsyntax#}.</li>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>See also {#link|@shlExact#}.</li>
<li>See also {#link|@shlWithOverflow#}.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<pre>{#syntax#}0b1 << 8 == 0b100000000{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Saturating Bit Shift Left</td>
<td><pre>{#syntax#}a <<| b
a <<|= b{#endsyntax#}</pre></td>
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
<td>
<ul>
<li>{#link|Integers#}</li>
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
<ul>
<li>See also {#link|@shlExact#}.</li>
<li>See also {#link|@shlWithOverflow#}.</li>
</ul>
</td>
<td>
<pre>{#syntax#}@as(u8, 1) <<| 8 == 255{#endsyntax#}</pre>
</td>
</tr>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Bit Shift Right</td>
<td><pre>{#syntax#}a >> b
a >>= b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<li>Moves all bits to the right, inserting zeroes at the most-significant bit.</li>
<li>{#syntax#}b{#endsyntax#} must be
{#link|comptime-known|comptime#} or have a type with log2 number
of bits as {#syntax#}a{#endsyntax#}.</li>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>See also {#link|@shrExact#}.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<pre>{#syntax#}0b1010 >> 1 == 0b101{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Bitwise And</td>
<td><pre>{#syntax#}a & b
a &= b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
<ul>
<li>Invokes {#link|Peer Type Resolution#} for the operands.</li>
</ul>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
docs: fix double escaping html entities
2018-10-05 14:21:08 +00:00
<pre>{#syntax#}0b011 & 0b101 == 0b001{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Bitwise Or</td>
<td><pre>{#syntax#}a | b
a |= b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
<ul>
<li>Invokes {#link|Peer Type Resolution#} for the operands.</li>
</ul>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}0b010 | 0b100 == 0b110{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Bitwise Xor</td>
<td><pre>{#syntax#}a ^ b
a ^= b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
<ul>
<li>Invokes {#link|Peer Type Resolution#} for the operands.</li>
</ul>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}0b011 ^ 0b101 == 0b110{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Bitwise Not</td>
<td><pre>{#syntax#}~a{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
Update the docs to use `@as`
2019-12-03 10:56:50 +00:00
<pre>{#syntax#}~@as(u8, 0b10101111) == 0b01010000{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Defaulting Optional Unwrap</td>
<td><pre>{#syntax#}a orelse b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
breaking syntax change: ??x to x.? (#1095) See #1023 This also renames Nullable/Maybe to Optional
2018-06-10 03:42:14 +00:00
<li>{#link|Optionals#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<td>If {#syntax#}a{#endsyntax#} is {#syntax#}null{#endsyntax#},
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
returns {#syntax#}b{#endsyntax#} ("default value"),
otherwise returns the unwrapped value of {#syntax#}a{#endsyntax#}.
Note that {#syntax#}b{#endsyntax#} may be a value of type {#link|noreturn#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}const value: ?u32 = null;
breaking syntax change: orelse keyword instead of ?? (#1096) use the `zig-fmt-optional-default` branch to have zig fmt automatically do the changes. closes #1023
2018-06-10 05:13:51 +00:00
const unwrapped = value orelse 1234;
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
unwrapped == 1234{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Optional Unwrap</td>
<td><pre>{#syntax#}a.?{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
breaking syntax change: ??x to x.? (#1095) See #1023 This also renames Nullable/Maybe to Optional
2018-06-10 03:42:14 +00:00
<li>{#link|Optionals#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
Equivalent to:
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}a orelse unreachable{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}const value: ?u32 = 5678;
value.? == 5678{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Defaulting Error Unwrap</td>
<td><pre>{#syntax#}a catch b
a catch |err| b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Error Unions|Errors#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
New Zig formal grammar (#1685) Reverted #1628 and changed the grammar+parser of the language to not allow certain expr where types are expected
2018-11-13 13:08:37 +00:00
<td>If {#syntax#}a{#endsyntax#} is an {#syntax#}error{#endsyntax#},
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
returns {#syntax#}b{#endsyntax#} ("default value"),
otherwise returns the unwrapped value of {#syntax#}a{#endsyntax#}.
Note that {#syntax#}b{#endsyntax#} may be a value of type {#link|noreturn#}.
{#syntax#}err{#endsyntax#} is the {#syntax#}error{#endsyntax#} and is in scope of the expression {#syntax#}b{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
New Zig formal grammar (#1685) Reverted #1628 and changed the grammar+parser of the language to not allow certain expr where types are expected
2018-11-13 13:08:37 +00:00
<pre>{#syntax#}const value: anyerror!u32 = error.Broken;
replace `a %% b` with `a catch b` See #632 better fits the convention of using keywords for control flow
2018-01-07 22:28:20 +00:00
const unwrapped = value catch 1234;
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
unwrapped == 1234{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Logical And</td>
<td><pre>{#syntax#}a and b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|bool|Primitive Types#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
If {#syntax#}a{#endsyntax#} is {#syntax#}false{#endsyntax#}, returns {#syntax#}false{#endsyntax#}
without evaluating {#syntax#}b{#endsyntax#}. Otherwise, returns {#syntax#}b{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
Fix #3272 - update docs
2019-09-22 15:13:36 +00:00
<pre>{#syntax#}(false and true) == false{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Logical Or</td>
<td><pre>{#syntax#}a or b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|bool|Primitive Types#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
If {#syntax#}a{#endsyntax#} is {#syntax#}true{#endsyntax#},
returns {#syntax#}true{#endsyntax#} without evaluating
{#syntax#}b{#endsyntax#}. Otherwise, returns
{#syntax#}b{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
fix precedence in langref or example
2021-12-10 09:22:32 +00:00
<pre>{#syntax#}(false or true) == true{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Boolean Not</td>
<td><pre>{#syntax#}!a{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|bool|Primitive Types#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}!false == true{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Equality</td>
<td><pre>{#syntax#}a == b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
<li>{#link|Floats#}</li>
<li>{#link|bool|Primitive Types#}</li>
<li>{#link|type|Primitive Types#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Returns {#syntax#}true{#endsyntax#} if a and b are equal, otherwise returns {#syntax#}false{#endsyntax#}.
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
Invokes {#link|Peer Type Resolution#} for the operands.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}(1 == 1) == true{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Null Check</td>
<td><pre>{#syntax#}a == null{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
breaking syntax change: ??x to x.? (#1095) See #1023 This also renames Nullable/Maybe to Optional
2018-06-10 03:42:14 +00:00
<li>{#link|Optionals#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Returns {#syntax#}true{#endsyntax#} if a is {#syntax#}null{#endsyntax#}, otherwise returns {#syntax#}false{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}const value: ?u32 = null;
Add missing != null operator
2024-01-16 17:50:47 +00:00
(value == null) == true{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Inequality</td>
<td><pre>{#syntax#}a != b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
<li>{#link|Floats#}</li>
<li>{#link|bool|Primitive Types#}</li>
<li>{#link|type|Primitive Types#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Returns {#syntax#}false{#endsyntax#} if a and b are equal, otherwise returns {#syntax#}true{#endsyntax#}.
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
Invokes {#link|Peer Type Resolution#} for the operands.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}(1 != 1) == false{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
Add missing != null operator
2024-01-16 17:50:47 +00:00
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Non-Null Check</td>
<td><pre>{#syntax#}a != null{#endsyntax#}</pre></td>
Add missing != null operator
2024-01-16 17:50:47 +00:00
<td>
<ul>
<li>{#link|Optionals#}</li>
</ul>
</td>
<td>
Returns {#syntax#}false{#endsyntax#} if a is {#syntax#}null{#endsyntax#}, otherwise returns {#syntax#}true{#endsyntax#}.
</td>
<td>
<pre>{#syntax#}const value: ?u32 = null;
(value != null) == false{#endsyntax#}</pre>
</td>
</tr>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Greater Than</td>
<td><pre>{#syntax#}a > b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
<li>{#link|Floats#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Returns {#syntax#}true{#endsyntax#} if a is greater than b, otherwise returns {#syntax#}false{#endsyntax#}.
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
Invokes {#link|Peer Type Resolution#} for the operands.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}(2 > 1) == true{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Greater or Equal</td>
<td><pre>{#syntax#}a >= b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
<li>{#link|Floats#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Returns {#syntax#}true{#endsyntax#} if a is greater than or equal to b, otherwise returns {#syntax#}false{#endsyntax#}.
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
Invokes {#link|Peer Type Resolution#} for the operands.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}(2 >= 1) == true{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Less Than</td>
<td><pre>{#syntax#}a < b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
<li>{#link|Floats#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Returns {#syntax#}true{#endsyntax#} if a is less than b, otherwise returns {#syntax#}false{#endsyntax#}.
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
Invokes {#link|Peer Type Resolution#} for the operands.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
Fix doc - Language Reference - Table of Operators
2024-03-04 09:15:57 +00:00
<pre>{#syntax#}(1 < 2) == true{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Lesser or Equal</td>
<td><pre>{#syntax#}a <= b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Integers#}</li>
<li>{#link|Floats#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Returns {#syntax#}true{#endsyntax#} if a is less than or equal to b, otherwise returns {#syntax#}false{#endsyntax#}.
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
Invokes {#link|Peer Type Resolution#} for the operands.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}(1 <= 2) == true{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Array Concatenation</td>
<td><pre>{#syntax#}a ++ b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Arrays#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
<ul>
langref: update docs for ** and ++ This behavior changed with https://github.com/ziglang/zig/issues/7147
2023-07-23 18:24:32 +00:00
<li>Only available when the lengths of both {#syntax#}a{#endsyntax#} and {#syntax#}b{#endsyntax#} are {#link|compile-time known|comptime#}.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}const mem = @import("std").mem;
different array literal syntax when inferring the size old syntax: []i32{1, 2, 3} new syntax: [_]i32{1, 2, 3} closes #1797
2019-06-09 23:24:24 +00:00
const array1 = [_]u32{1,2};
const array2 = [_]u32{3,4};
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
const together = array1 ++ array2;
mem.eql need slice type
2020-05-10 12:35:21 +00:00
mem.eql(u32, &together, &[_]u32{1,2,3,4}){#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Array Multiplication</td>
<td><pre>{#syntax#}a ** b{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Arrays#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
<ul>
langref: update docs for ** and ++ This behavior changed with https://github.com/ziglang/zig/issues/7147
2023-07-23 18:24:32 +00:00
<li>Only available when the length of {#syntax#}a{#endsyntax#} and {#syntax#}b{#endsyntax#} are {#link|compile-time known|comptime#}.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}const mem = @import("std").mem;
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
const pattern = "ab" ** 3;
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
mem.eql(u8, pattern, "ababab"){#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Pointer Dereference</td>
<td><pre>{#syntax#}a.*{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Pointers#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
</td>
<td>
Pointer dereference.
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}const x: u32 = 1234;
const ptr = &x;
Fix typos around pointer usage
2019-03-22 17:57:00 +00:00
ptr.* == 1234{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Address Of</td>
<td><pre>{#syntax#}&a{#endsyntax#}</pre></td>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<td>
All types
</td>
<td>
</td>
<td>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}const x: u32 = 1234;
const ptr = &x;
Fix typos around pointer usage
2019-03-22 17:57:00 +00:00
ptr.* == 1234{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</td>
</tr>
langref: add merge error sets operator to operator table
2018-06-13 15:09:41 +00:00
<tr>
langref: clean up the table of operators * remove whitespace * add column for name * rename "description" to "remarks" * clarify bit shift left and bit shift right closes #17126
2024-01-22 02:40:41 +00:00
<td>Error Set Merge</td>
<td><pre>{#syntax#}a || b{#endsyntax#}</pre></td>
langref: add merge error sets operator to operator table
2018-06-13 15:09:41 +00:00
<td>
<ul>
<li>{#link|Error Set Type#}</li>
</ul>
</td>
<td>
{#link|Merging Error Sets#}
</td>
<td>
New Zig formal grammar (#1685) Reverted #1628 and changed the grammar+parser of the language to not allow certain expr where types are expected
2018-11-13 13:08:37 +00:00
<pre>{#syntax#}const A = error{One};
const B = error{Two};
(A || B) == error{One, Two}{#endsyntax#}</pre>
langref: add merge error sets operator to operator table
2018-06-13 15:09:41 +00:00
</td>
</tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</tbody>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</table>
Improve documentation styling for mobile devices - No overscrolling on small screens - Font-size is reduced for more content per screen - Tables + Code blocks scroll within a block to avoid page-widenening
2018-01-30 04:33:38 +00:00
</div>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Precedence#}
fix position of `.*` and `.?` in operator precedence table documentation
2021-05-25 04:09:28 +00:00
<pre>{#syntax#}x() x[] x.y x.* x.?
error sets - update langref. all tests passing
2018-02-08 08:02:41 +00:00
a!b
fix position of `.*` and `.?` in operator precedence table documentation
2021-05-25 04:09:28 +00:00
x{}
Fix operator precedence documentation
2020-12-09 06:58:24 +00:00
!x -x -%x ~x &x ?x
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
* / % ** *% *| ||
+ - ++ +% -% +| -|
<< >> <<|
fix position of `orelse` and `catch` in precedence table and remove misplaced error union operator
2021-05-24 20:58:20 +00:00
& ^ | orelse catch
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
== != < > <= >=
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
and
or
sat-arithmetic: update langref
2021-09-09 03:59:55 +00:00
= *= *%= *|= /= %= += +%= +|= -= -%= -|= <<= <<|= >>= &= ^= |={#endsyntax#}</pre>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_close#}
{#header_open|Arrays#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_arrays.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
organize the docs and some rewording
2019-07-16 17:13:21 +00:00
{#see_also|for|Slices#}
Add multidimensional array example
2019-07-15 22:20:56 +00:00
organize the docs and some rewording
2019-07-16 17:13:21 +00:00
{#header_open|Multidimensional Arrays#}
<p>
Spelling corrections (#9833) Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2021-09-24 17:39:20 +00:00
Multidimensional arrays can be created by nesting arrays:
organize the docs and some rewording
2019-07-16 17:13:21 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_multidimensional_arrays.zig#}
organize the docs and some rewording
2019-07-16 17:13:21 +00:00
{#header_close#}
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
langref: update for sentinel-terminated types
2019-11-24 03:29:12 +00:00
{#header_open|Sentinel-Terminated Arrays#}
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
<p>
doc/langref: mention that x is the sentinel in [N:x]T Without looking at the example it is not possible to know whether N or x is the sentinel value. Fix it.
2020-01-11 21:59:19 +00:00
The syntax {#syntax#}[N:x]T{#endsyntax#} describes an array which has a sentinel element of value {#syntax#}x{#endsyntax#} at the
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
index corresponding to the length {#syntax#}N{#endsyntax#}.
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_null_terminated_array.zig#}
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
langref: update for sentinel-terminated types
2019-11-24 03:29:12 +00:00
{#see_also|Sentinel-Terminated Pointers|Sentinel-Terminated Slices#}
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
introduce vector type for SIMD See #903 * create with `@Vector(len, ElemType)` * only wrapping addition is implemented This feature is far from complete; this is only the beginning.
2019-01-31 04:36:52 +00:00
{#header_open|Vectors#}
<p>
basic language features do not belong in std.meta
2022-03-14 05:21:16 +00:00
A vector is a group of booleans, {#link|Integers#}, {#link|Floats#}, or
{#link|Pointers#} which are operated on in parallel, using SIMD instructions if possible.
Vector types are created with the builtin function {#link|@Vector#}.
introduce vector type for SIMD See #903 * create with `@Vector(len, ElemType)` * only wrapping addition is implemented This feature is far from complete; this is only the beginning.
2019-01-31 04:36:52 +00:00
</p>
<p>
basic language features do not belong in std.meta
2022-03-14 05:21:16 +00:00
Vectors support the same builtin operators as their underlying base types.
These operations are performed element-wise, and return a vector of the same length
as the input vectors. This includes:
langref: fix tidy html error regressed in 8468b544e8769b774e2e5988a58c51d991df999a
2021-12-19 06:57:00 +00:00
</p>
Add Vector documentation (#10303) * Create Vector language documentation Main changes to docs: 1. Create brief documentation on Zig vector types with code example 2. Get rid of the SIMD sub-heading under the main Vectors heading, and update links accordingly 3. Add an example to the `@shuffle` docs
2021-12-19 04:40:57 +00:00
<ul>
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
<li>Arithmetic ({#syntax#}+{#endsyntax#}, {#syntax#}-{#endsyntax#}, {#syntax#}/{#endsyntax#}, {#syntax#}*{#endsyntax#},
{#syntax#}@divFloor{#endsyntax#}, {#syntax#}@sqrt{#endsyntax#}, {#syntax#}@ceil{#endsyntax#},
Add Vector documentation (#10303) * Create Vector language documentation Main changes to docs: 1. Create brief documentation on Zig vector types with code example 2. Get rid of the SIMD sub-heading under the main Vectors heading, and update links accordingly 3. Add an example to the `@shuffle` docs
2021-12-19 04:40:57 +00:00
{#syntax#}@log{#endsyntax#}, etc.)</li>
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
<li>Bitwise operators ({#syntax#}>>{#endsyntax#}, {#syntax#}<<{#endsyntax#}, {#syntax#}&{#endsyntax#},
Add Vector documentation (#10303) * Create Vector language documentation Main changes to docs: 1. Create brief documentation on Zig vector types with code example 2. Get rid of the SIMD sub-heading under the main Vectors heading, and update links accordingly 3. Add an example to the `@shuffle` docs
2021-12-19 04:40:57 +00:00
{#syntax#}|{#endsyntax#}, {#syntax#}~{#endsyntax#}, etc.)</li>
<li>Comparison operators ({#syntax#}<{#endsyntax#}, {#syntax#}>{#endsyntax#}, {#syntax#}=={#endsyntax#}, etc.)</li>
</ul>
introduce vector type for SIMD See #903 * create with `@Vector(len, ElemType)` * only wrapping addition is implemented This feature is far from complete; this is only the beginning.
2019-01-31 04:36:52 +00:00
<p>
basic language features do not belong in std.meta
2022-03-14 05:21:16 +00:00
It is prohibited to use a math operator on a mixture of scalars (individual numbers)
and vectors. Zig provides the {#link|@splat#} builtin to easily convert from scalars
to vectors, and it supports {#link|@reduce#} and array indexing syntax to convert
from vectors to scalars. Vectors also support assignment to and from fixed-length
langref: consistently use comptime-known and runtime-known
2022-12-09 11:02:27 +00:00
arrays with comptime-known length.
introduce vector type for SIMD See #903 * create with `@Vector(len, ElemType)` * only wrapping addition is implemented This feature is far from complete; this is only the beginning.
2019-01-31 04:36:52 +00:00
</p>
Add Vector documentation (#10303) * Create Vector language documentation Main changes to docs: 1. Create brief documentation on Zig vector types with code example 2. Get rid of the SIMD sub-heading under the main Vectors heading, and update links accordingly 3. Add an example to the `@shuffle` docs
2021-12-19 04:40:57 +00:00
<p>
For rearranging elements within and between vectors, Zig provides the {#link|@shuffle#} and {#link|@select#} functions.
</p>
<p>
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
Operations on vectors shorter than the target machine's native SIMD size will typically compile to single SIMD
instructions, while vectors longer than the target machine's native SIMD size will compile to multiple SIMD
instructions. If a given operation doesn't have SIMD support on the target architecture, the compiler will default
to operating on each vector element one at a time. Zig supports any comptime-known vector length up to 2^32-1,
although small powers of two (2-64) are most typical. Note that excessively long vector lengths (e.g. 2^20) may
Add Vector documentation (#10303) * Create Vector language documentation Main changes to docs: 1. Create brief documentation on Zig vector types with code example 2. Get rid of the SIMD sub-heading under the main Vectors heading, and update links accordingly 3. Add an example to the `@shuffle` docs
2021-12-19 04:40:57 +00:00
result in compiler crashes on current versions of Zig.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_vector.zig#}
Add Vector documentation (#10303) * Create Vector language documentation Main changes to docs: 1. Create brief documentation on Zig vector types with code example 2. Get rid of the SIMD sub-heading under the main Vectors heading, and update links accordingly 3. Add an example to the `@shuffle` docs
2021-12-19 04:40:57 +00:00
<p>
TODO talk about C ABI interop<br>
TODO consider suggesting std.MultiArrayList
</p>
{#see_also|@splat|@shuffle|@select|@reduce#}
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
introduce vector type for SIMD See #903 * create with `@Vector(len, ElemType)` * only wrapping addition is implemented This feature is far from complete; this is only the beginning.
2019-01-31 04:36:52 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Pointers#}
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
<p>
langref: Use "single-item pointer" and "many-item pointer" (#8217) These terms give short, descriptive names for the two pointer types which reflect the names used in src/type.zig.
2021-03-13 01:10:55 +00:00
Zig has two kinds of pointers: single-item and many-item.
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
</p>
<ul>
langref: Use "single-item pointer" and "many-item pointer" (#8217) These terms give short, descriptive names for the two pointer types which reflect the names used in src/type.zig.
2021-03-13 01:10:55 +00:00
<li>{#syntax#}*T{#endsyntax#} - single-item pointer to exactly one item.
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
<ul>
<li>Supports deref syntax: {#syntax#}ptr.*{#endsyntax#}</li>
single pointer slice syntax added
2024-07-17 14:06:34 +00:00
<li>Supports slice syntax: {#syntax#}ptr[0..1]{#endsyntax#}</li>
Sema: support pointer subtraction
2024-07-15 18:18:38 +00:00
<li>Supports pointer subtraction: {#syntax#}ptr - ptr{#endsyntax#}</li>
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
</ul>
</li>
langref: Use "single-item pointer" and "many-item pointer" (#8217) These terms give short, descriptive names for the two pointer types which reflect the names used in src/type.zig.
2021-03-13 01:10:55 +00:00
<li>{#syntax#}[*]T{#endsyntax#} - many-item pointer to unknown number of items.
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
<ul>
<li>Supports index syntax: {#syntax#}ptr[i]{#endsyntax#}</li>
sema: allow slicing [*]T without end
2023-11-07 09:19:59 +00:00
<li>Supports slice syntax: {#syntax#}ptr[start..end]{#endsyntax#} and {#syntax#}ptr[start..]{#endsyntax#}</li>
Sema: support pointer subtraction
2024-07-15 18:18:38 +00:00
<li>Supports pointer-integer arithmetic: {#syntax#}ptr + int{#endsyntax#}, {#syntax#}ptr - int{#endsyntax#}</li>
<li>Supports pointer subtraction: {#syntax#}ptr - ptr{#endsyntax#}</li>
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
</ul>
Sema: support pointer subtraction
2024-07-15 18:18:38 +00:00
{#syntax#}T{#endsyntax#} must have a known size, which means that it cannot be
{#syntax#}anyopaque{#endsyntax#} or any other {#link|opaque type|opaque#}.
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
</li>
</ul>
<p>These types are closely related to {#link|Arrays#} and {#link|Slices#}:</p>
<ul>
langref: Use "single-item pointer" and "many-item pointer" (#8217) These terms give short, descriptive names for the two pointer types which reflect the names used in src/type.zig.
2021-03-13 01:10:55 +00:00
<li>{#syntax#}*[N]T{#endsyntax#} - pointer to N items, same as single-item pointer to an array.
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
<ul>
<li>Supports index syntax: {#syntax#}array_ptr[i]{#endsyntax#}</li>
<li>Supports slice syntax: {#syntax#}array_ptr[start..end]{#endsyntax#}</li>
<li>Supports len property: {#syntax#}array_ptr.len{#endsyntax#}</li>
Sema: support pointer subtraction
2024-07-15 18:18:38 +00:00
<li>Supports pointer subtraction: {#syntax#}array_ptr - array_ptr{#endsyntax#}</li>
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
</ul>
</li>
</ul>
<ul>
langref: tweak description of `[]T` (#12319) saying []T is a pointer is confusing because zig docs say there are two types of pointers (*T and [*]T). It is more clear to say that []T is a slice type which contains a [*]T pointer and a length. Co-authored-by: Philipp Lühmann <47984692+luehmann@users.noreply.github.com>
2022-09-01 01:53:00 +00:00
<li>{#syntax#}[]T{#endsyntax#} - is a slice (a fat pointer, which contains a pointer of type {#syntax#}[*]T{#endsyntax#} and a length).
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
<ul>
<li>Supports index syntax: {#syntax#}slice[i]{#endsyntax#}</li>
<li>Supports slice syntax: {#syntax#}slice[start..end]{#endsyntax#}</li>
<li>Supports len property: {#syntax#}slice.len{#endsyntax#}</li>
</ul>
</li>
</ul>
<p>Use {#syntax#}&x{#endsyntax#} to obtain a single-item pointer:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_single_item_pointer.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docs: Pointer Arithmetic
2022-07-23 10:57:40 +00:00
<p>
Zig supports pointer arithmetic. It's better to assign the pointer to {#syntax#}[*]T{#endsyntax#} and increment that variable. For example, directly incrementing the pointer from a slice will corrupt it.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_pointer_arithmetic.zig#}
docs: Pointer Arithmetic
2022-07-23 10:57:40 +00:00
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
<p>
langref: update for sentinel-terminated types
2019-11-24 03:29:12 +00:00
In Zig, we generally prefer {#link|Slices#} rather than {#link|Sentinel-Terminated Pointers#}.
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
You can turn an array or pointer into a slice using slice syntax.
</p>
<p>
Slices have bounds checking and are therefore protected
against this kind of undefined behavior. This is one reason
we prefer slices to pointers.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_slice_bounds.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
<p>Pointers work at compile-time too, as long as the code does not depend on
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
an undefined memory layout:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_pointers.zig#}
all: zig fmt and rename "@XToY" to "@YFromX" Signed-off-by: Eric Joldasov <bratishkaerik@getgoogleoff.me>
2023-06-15 07:14:16 +00:00
<p>To convert an integer address into a pointer, use {#syntax#}@ptrFromInt{#endsyntax#}.
To convert a pointer to an integer, use {#syntax#}@intFromPtr{#endsyntax#}:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_integer_pointer_conversion.zig#}
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
<p>Zig is able to preserve memory addresses in comptime code, as long as
the pointer is never dereferenced:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_pointer_conversion.zig#}
all: zig fmt and rename "@XToY" to "@YFromX" Signed-off-by: Eric Joldasov <bratishkaerik@getgoogleoff.me>
2023-06-15 07:14:16 +00:00
{#see_also|Optional Pointers|@ptrFromInt|@intFromPtr|C Pointers#}
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
{#header_open|volatile#}
<p>Loads and stores are assumed to not have side effects. If a given load or store
should have side effects, such as Memory Mapped Input/Output (MMIO), use {#syntax#}volatile{#endsyntax#}.
In the following code, loads and stores with {#syntax#}mmio_ptr{#endsyntax#} are guaranteed to all happen
and in the same order as in source code:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_volatile.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
<p>
Note that {#syntax#}volatile{#endsyntax#} is unrelated to concurrency and {#link|Atomics#}.
If you see code that is using {#syntax#}volatile{#endsyntax#} for something other than Memory Mapped
Input/Output, it is probably a bug.
</p>
{#header_close#}
<p>
langref: avoid the ambiguous word "safe" See #2402
2024-01-19 03:58:35 +00:00
{#link|@ptrCast#} converts a pointer's element type to another. This
creates a new pointer that can cause undetectable illegal behavior
depending on the loads and stores that pass through it. Generally, other
kinds of type conversions are preferable to
{#syntax#}@ptrCast{#endsyntax#} if possible.
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_pointer_casting.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Alignment#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Each type has an <strong>alignment</strong> - a number of bytes such that,
when a value of the type is loaded from or stored to memory,
the memory address must be evenly divisible by this number. You can use
docgen: verify internal links
2018-01-23 04:06:07 +00:00
{#link|@alignOf#} to find out this value for any type.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
Alignment depends on the CPU architecture, but is always a power of two, and
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
less than {#syntax#}1 << 29{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
In Zig, a pointer type has an alignment value. If the value is equal to the
alignment of the underlying type, it can be omitted from the type:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_variable_alignment.zig#}
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
<p>In the same way that a {#syntax#}*i32{#endsyntax#} can be {#link|coerced|Type Coercion#} to a
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}*const i32{#endsyntax#}, a pointer with a larger alignment can be implicitly
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
cast to a pointer with a smaller alignment, but not vice versa.
</p>
<p>
You can specify alignment on variables and functions. If you do this, then
pointers to them get the specified alignment:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_variable_func_alignment.zig#}
AstGen: disallow alignment on function types A pointer type already has an alignment, so this information does not need to be duplicated on the function type. This already has precedence with addrspace which is already disallowed on function types for this reason. Also fixes `@TypeOf(&func)` to have the correct addrspace and alignment.
2024-03-16 15:46:45 +00:00
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
If you have a pointer or a slice that has a small alignment, but you know that it actually
docgen: verify internal links
2018-01-23 04:06:07 +00:00
has a bigger alignment, use {#link|@alignCast#} to change the
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
pointer into a more aligned pointer. This is a no-op at runtime, but inserts a
docgen: verify internal links
2018-01-23 04:06:07 +00:00
{#link|safety check|Incorrect Pointer Alignment#}:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_incorrect_pointer_alignment.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
implement allowzero pointer attribute closes #1953 only needed for freestanding targets. also adds safety for `@intToPtr` when the address is zero.
2019-03-25 16:55:45 +00:00
{#header_open|allowzero#}
<p>
This pointer attribute allows a pointer to have address zero. This is only ever needed on the
doc: recommend optional pointers for nullptrs instead of allowzero
2019-05-31 02:38:26 +00:00
freestanding OS target, where the address zero is mappable. If you want to represent null pointers, use
Clarify allowzero's interaction with optional pointers.
2019-12-17 04:55:35 +00:00
{#link|Optional Pointers#} instead. {#link|Optional Pointers#} with {#syntax#}allowzero{#endsyntax#}
are not the same size as pointers. In this code example, if the pointer
did not have the {#syntax#}allowzero{#endsyntax#} attribute, this would be a
{#link|Pointer Cast Invalid Null#} panic:
implement allowzero pointer attribute closes #1953 only needed for freestanding targets. also adds safety for `@intToPtr` when the address is zero.
2019-03-25 16:55:45 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_allowzero.zig#}
implement allowzero pointer attribute closes #1953 only needed for freestanding targets. also adds safety for `@intToPtr` when the address is zero.
2019-03-25 16:55:45 +00:00
{#header_close#}
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
langref: update for sentinel-terminated types
2019-11-24 03:29:12 +00:00
{#header_open|Sentinel-Terminated Pointers#}
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
<p>
langref: update for sentinel-terminated types
2019-11-24 03:29:12 +00:00
The syntax {#syntax#}[*:x]T{#endsyntax#} describes a pointer that
has a length determined by a sentinel value. This provides protection
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
against buffer overflow and overreads.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|sentinel-terminated_pointer.zig#}
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
langref: update for sentinel-terminated types
2019-11-24 03:29:12 +00:00
{#see_also|Sentinel-Terminated Slices|Sentinel-Terminated Arrays#}
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
add docs for C pointers
2019-02-14 23:59:20 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Slices#}
Doc: elaborate on Slice section somehow the concept of slices had less elaboration in its own dedicated section than the mentions of it elsewhere.
2023-10-27 23:11:56 +00:00
<p>
A slice is a pointer and a length. The difference between an array and
a slice is that the array's length is part of the type and known at
compile-time, whereas the slice's length is known at runtime.
autodoc: fix misaligned table header when alignment is default (#20220)
2024-06-08 19:37:07 +00:00
Both can be accessed with the {#syntax#}len{#endsyntax#} field.
Doc: elaborate on Slice section somehow the concept of slices had less elaboration in its own dedicated section than the mentions of it elsewhere.
2023-10-27 23:11:56 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_basic_slices.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>This is one reason we prefer slices to pointers.</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_slices.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|Pointers|for|Arrays#}
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
langref: update for sentinel-terminated types
2019-11-24 03:29:12 +00:00
{#header_open|Sentinel-Terminated Slices#}
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
<p>
langref: consistently use comptime-known and runtime-known
2022-12-09 11:02:27 +00:00
The syntax {#syntax#}[:x]T{#endsyntax#} is a slice which has a runtime-known length
langref: update for sentinel-terminated types
2019-11-24 03:29:12 +00:00
and also guarantees a sentinel value at the element indexed by the length. The type does not
guarantee that there are no sentinel elements before that. Sentinel-terminated slices allow element
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
access to the {#syntax#}len{#endsyntax#} index.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_null_terminated_slice.zig#}
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
Add documentation for sentinel-terminated slicing (#10010) closes #9680
2021-12-04 01:37:48 +00:00
<p>
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
Sentinel-terminated slices can also be created using a variation of the slice syntax
{#syntax#}data[start..end :x]{#endsyntax#}, where {#syntax#}data{#endsyntax#} is a many-item pointer,
Add documentation for sentinel-terminated slicing (#10010) closes #9680
2021-12-04 01:37:48 +00:00
array or slice and {#syntax#}x{#endsyntax#} is the sentinel value.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_null_terminated_slicing.zig#}
Add documentation for sentinel-terminated slicing (#10010) closes #9680
2021-12-04 01:37:48 +00:00
<p>
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
Sentinel-terminated slicing asserts that the element in the sentinel position of the backing data is
Add documentation for sentinel-terminated slicing (#10010) closes #9680
2021-12-04 01:37:48 +00:00
actually the sentinel value. If this is not the case, safety-protected {#link|Undefined Behavior#} results.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_sentinel_mismatch.zig#}
Add documentation for sentinel-terminated slicing (#10010) closes #9680
2021-12-04 01:37:48 +00:00
langref: update for sentinel-terminated types
2019-11-24 03:29:12 +00:00
{#see_also|Sentinel-Terminated Pointers|Sentinel-Terminated Arrays#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
update docs for null terminated stuff
2019-11-20 22:11:07 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|struct#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_structs.zig#}
langref: fix unused vars
2021-06-23 18:32:28 +00:00
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
default struct field initialization expressions closes #485
2019-05-30 19:35:30 +00:00
{#header_open|Default Field Values#}
<p>
langref: caution against default field values closes #19169
2024-03-15 23:37:13 +00:00
Each struct field may have an expression indicating the default field
value. Such expressions are executed at {#link|comptime#}, and allow the
field to be omitted in a struct literal expression:
default struct field initialization expressions closes #485
2019-05-30 19:35:30 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|struct_default_field_values.zig#}
default struct field initialization expressions closes #485
2019-05-30 19:35:30 +00:00
langref: separate header for faulty default field values
2024-08-31 04:12:17 +00:00
{#header_open|Faulty Default Field Values#}
langref: caution against default field values closes #19169
2024-03-15 23:37:13 +00:00
<p>
Default field values are only appropriate when the data invariants of a struct
cannot be violated by omitting that field from an initialization.
</p>
<p>
For example, here is an inappropriate use of default struct field initialization:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|bad_default_value.zig#}
langref: caution against default field values closes #19169
2024-03-15 23:37:13 +00:00
<p>
Above you can see the danger of ignoring this principle. The default
field values caused the data invariant to be violated, causing illegal
behavior.
</p>
<p>
To fix this, remove the default values from all the struct fields, and provide
a named default value:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|struct_default_value.zig#}
langref: caution against default field values closes #19169
2024-03-15 23:37:13 +00:00
<p>If a struct value requires a runtime-known value in order to be initialized
without violating data invariants, then use an initialization method that accepts
those runtime values, and populates the remaining fields.</p>
default struct field initialization expressions closes #485
2019-05-30 19:35:30 +00:00
{#header_close#}
langref: separate header for faulty default field values
2024-08-31 04:12:17 +00:00
{#header_close#}
default struct field initialization expressions closes #485
2019-05-30 19:35:30 +00:00
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
{#header_open|extern struct#}
langref: clarify struct memory layout
2023-10-30 23:27:12 +00:00
<p>An {#syntax#}extern struct{#endsyntax#} has in-memory layout matching
the C ABI for the target.</p>
<p>If well-defined in-memory layout is not required, {#link|struct#} is a better choice
because it places fewer restrictions on the compiler.</p>
<p>See {#link|packed struct#} for a struct that has the ABI of its backing integer,
which can be useful for modeling flags.</p>
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
{#see_also|extern union|extern enum#}
{#header_close#}
fixups
2018-09-21 18:15:58 +00:00
{#header_open|packed struct#}
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
<p>
Unlike normal structs, {#syntax#}packed{#endsyntax#} structs have guaranteed in-memory layout:
</p>
<ul>
packed struct fix example and clarify least to most significant ordering The packed struct example was mistakenly applying endianness where it shouldn't have been. This wasn't being caught because we don't currently test the examples on Big-endian systems. I updated the test to remove the endianness where it didn't apply, and added a new part of the test to demonstrate when it would apply.
2022-11-17 06:41:54 +00:00
<li>Fields remain in the order declared, least to most significant.</li>
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
<li>There is no padding between fields.</li>
<li>Zig supports arbitrary width {#link|Integers#} and although normally, integers with fewer
than 8 bits will still use 1 byte of memory, in packed structs, they use
exactly their bit width.
</li>
<li>{#syntax#}bool{#endsyntax#} fields use exactly 1 bit.</li>
delete packed enums from the language No need for any such thing. Instead, provide an integer tag type for the enum.
2021-04-23 02:21:50 +00:00
<li>An {#link|enum#} field uses exactly the bit width of its integer tag type.</li>
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
<li>A {#link|packed union#} field uses exactly the bit width of the union field with
the largest bit width.</li>
implement packed struct equality (#21679)
2024-10-13 03:59:12 +00:00
<li>Packed structs support equality operators.</li>
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
</ul>
<p>
This means that a {#syntax#}packed struct{#endsyntax#} can participate
in a {#link|@bitCast#} or a {#link|@ptrCast#} to reinterpret memory.
This even works at {#link|comptime#}:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_packed_structs.zig#}
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
Document packed struct's backing int declaration
2024-04-08 03:01:30 +00:00
<p>
The backing integer is inferred from the fields' total bit width.
Optionally, it can be explicitly provided and enforced at compile time:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_missized_packed_struct.zig#}
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
<p>
Zig allows the address to be taken of a non-byte-aligned field:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_pointer_to_non-byte_aligned_field.zig#}
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
<p>
However, the pointer to a non-byte-aligned field has special properties and cannot
be passed when a normal pointer is expected:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_misaligned_pointer.zig#}
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
<p>
Spelling corrections (#9833) Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2021-09-24 17:39:20 +00:00
In this case, the function {#syntax#}bar{#endsyntax#} cannot be called because the pointer
regression fixes and fix packed struct abi size
2019-04-02 18:44:25 +00:00
to the non-ABI-aligned field mentions the bit offset, but the function expects an ABI-aligned pointer.
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
</p>
<p>
regression fixes and fix packed struct abi size
2019-04-02 18:44:25 +00:00
Pointers to non-ABI-aligned fields share the same address as the other fields within their host integer:
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_packed_struct_field_address.zig#}
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
<p>
Renamed @byteOffsetOf to @offsetOf
2021-06-10 20:56:55 +00:00
This can be observed with {#link|@bitOffsetOf#} and {#link|offsetOf#}:
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_bitOffsetOf_offsetOf.zig#}
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
<p>
make self-hosted the default compiler stage1 is available behind the -fstage1 flag. closes #89
2022-08-08 06:10:57 +00:00
Packed structs have the same alignment as their backing integer, however, overaligned
pointers to packed structs can override this:
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_overaligned_packed_struct.zig#}
make self-hosted the default compiler stage1 is available behind the -fstage1 flag. closes #89
2022-08-08 06:10:57 +00:00
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
<p>
Update doc for struct field alignment.
2021-04-13 12:53:44 +00:00
It's also possible to set alignment of struct fields:
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_aligned_struct_fields.zig#}
Update doc for struct field alignment.
2021-04-13 12:53:44 +00:00
implement packed struct equality (#21679)
2024-10-13 03:59:12 +00:00
<p>
Equating packed structs results in a comparison of the backing integer,
and only works for the `==` and `!=` operators.
</p>
{#code|test_packed_struct_equality.zig#}
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
<p>
Using packed structs with {#link|volatile#} is problematic, and may be a compile error in the future.
For details on this subscribe to
<a href="https://github.com/ziglang/zig/issues/1761">this issue</a>.
TODO update these docs with a recommendation on how to use packed structs with MMIO
(the use case for volatile packed structs) once this issue is resolved.
Don't worry, there will be a good solution for this use case in zig.
</p>
fixups
2018-09-21 18:15:58 +00:00
{#header_close#}
update docs for anonymous struct/list literals
2019-11-12 00:57:57 +00:00
{#header_open|Struct Naming#}
better anonymous struct naming this makes anonymous structs inherit the name of the function they are in only when they are the return expression. also document the behavior and provide examples. closes #1243
2018-09-03 15:32:39 +00:00
<p>Since all structs are anonymous, Zig infers the type name based on a few rules.</p>
<ul>
<li>If the struct is in the initialization expression of a variable, it gets named after
that variable.</li>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>If the struct is in the {#syntax#}return{#endsyntax#} expression, it gets named after
better anonymous struct naming this makes anonymous structs inherit the name of the function they are in only when they are the return expression. also document the behavior and provide examples. closes #1243
2018-09-03 15:32:39 +00:00
the function it is returning from, with the parameter values serialized.</li>
langref: update anonymous struct naming Closes #13841
2022-12-09 13:10:47 +00:00
<li>Otherwise, the struct gets a name such as <code>(filename.funcname.__struct_ID)</code>.</li>
stage1: make type names more unique
2022-03-19 11:26:21 +00:00
<li>If the struct is declared inside another struct, it gets named after both the parent
struct and the name inferred by the previous rules, separated by a dot.</li>
better anonymous struct naming this makes anonymous structs inherit the name of the function they are in only when they are the return expression. also document the behavior and provide examples. closes #1243
2018-09-03 15:32:39 +00:00
</ul>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|struct_name.zig#}
better anonymous struct naming this makes anonymous structs inherit the name of the function they are in only when they are the return expression. also document the behavior and provide examples. closes #1243
2018-09-03 15:32:39 +00:00
{#header_close#}
update docs for anonymous struct/list literals
2019-11-12 00:57:57 +00:00
{#header_open|Anonymous Struct Literals#}
<p>
Zig allows omitting the struct type of a literal. When the result is {#link|coerced|Type Coercion#},
langref: link "result location" to the "Result Location Semantics" section
2022-12-09 10:53:26 +00:00
the struct literal will directly instantiate the {#link|result location|Result Location Semantics#},
with no copy:
update docs for anonymous struct/list literals
2019-11-12 00:57:57 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_struct_result.zig#}
update docs for anonymous struct/list literals
2019-11-12 00:57:57 +00:00
<p>
langref: link "result location" to the "Result Location Semantics" section
2022-12-09 10:53:26 +00:00
The struct type can be inferred. Here the {#link|result location|Result Location Semantics#}
does not include a type, and so Zig infers the type:
update docs for anonymous struct/list literals
2019-11-12 00:57:57 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_anonymous_struct.zig#}
update docs for anonymous struct/list literals
2019-11-12 00:57:57 +00:00
Document tuple syntax Closes #13837
2022-12-10 03:10:55 +00:00
{#header_close#}
{#header_open|Tuples#}
add doc in `Anonymous Struct Literal` section for special @"0" syntax. (#8630)
2021-04-30 23:05:45 +00:00
<p>
Anonymous structs can be created without specifying field names, and are referred to as "tuples".
</p>
<p>
The fields are implicitly named using numbers starting from 0. Because their names are integers,
Document tuple syntax Closes #13837
2022-12-10 03:10:55 +00:00
they cannot be accessed with {#syntax#}.{#endsyntax#} syntax without also wrapping them in
{#syntax#}@""{#endsyntax#}. Names inside {#syntax#}@""{#endsyntax#} are always recognised as
{#link|identifiers|Identifiers#}.
add doc in `Anonymous Struct Literal` section for special @"0" syntax. (#8630)
2021-04-30 23:05:45 +00:00
</p>
<p>
Document tuple syntax Closes #13837
2022-12-10 03:10:55 +00:00
Like arrays, tuples have a .len field, can be indexed (provided the index is comptime-known)
and work with the ++ and ** operators. They can also be iterated over with {#link|inline for#}.
add doc in `Anonymous Struct Literal` section for special @"0" syntax. (#8630)
2021-04-30 23:05:45 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_tuples.zig#}
update docs for anonymous struct/list literals
2019-11-12 00:57:57 +00:00
{#header_close#}
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|comptime|@fieldParentPtr#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|enum#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_enums.zig#}
update docs regarding enums and unions
2017-12-04 06:42:02 +00:00
remove `@typeId`, `@memberCount`, `@memberName` and `@memberType` from the compiler
2020-02-24 21:21:11 +00:00
{#see_also|@typeInfo|@tagName|@sizeOf#}
add docs for enum literals closes #683
2019-07-04 03:09:58 +00:00
add new kind of test: generating .h files. and more * docgen supports obj_err code kind for demonstrating errors without explicit test cases * add documentation for `extern enum`. See #367 * remove coldcc keyword and add @setIsCold. See #661 * add compile errors for non-extern struct, enum, unions in function signatures * add .h file generation for extern struct, enum, unions
2018-01-23 03:24:07 +00:00
{#header_open|extern enum#}
<p>
By default, enums are not guaranteed to be compatible with the C ABI:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|enum_export_error.zig#}
add new kind of test: generating .h files. and more * docgen supports obj_err code kind for demonstrating errors without explicit test cases * add documentation for `extern enum`. See #367 * remove coldcc keyword and add @setIsCold. See #661 * add compile errors for non-extern struct, enum, unions in function signatures * add .h file generation for extern struct, enum, unions
2018-01-23 03:24:07 +00:00
<p>
langref: fix unused vars
2021-06-23 18:32:28 +00:00
For a C-ABI-compatible enum, provide an explicit tag type to
the enum:
add new kind of test: generating .h files. and more * docgen supports obj_err code kind for demonstrating errors without explicit test cases * add documentation for `extern enum`. See #367 * remove coldcc keyword and add @setIsCold. See #661 * add compile errors for non-extern struct, enum, unions in function signatures * add .h file generation for extern struct, enum, unions
2018-01-23 03:24:07 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|enum_export.zig#}
add new kind of test: generating .h files. and more * docgen supports obj_err code kind for demonstrating errors without explicit test cases * add documentation for `extern enum`. See #367 * remove coldcc keyword and add @setIsCold. See #661 * add compile errors for non-extern struct, enum, unions in function signatures * add .h file generation for extern struct, enum, unions
2018-01-23 03:24:07 +00:00
{#header_close#}
add docs for enum literals closes #683
2019-07-04 03:09:58 +00:00
{#header_open|Enum Literals#}
<p>
Enum literals allow specifying the name of an enum field without specifying the enum type:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_enum_literals.zig#}
add docs for enum literals closes #683
2019-07-04 03:09:58 +00:00
{#header_close#}
add non-exhaustive enum to langref
2020-01-15 21:05:52 +00:00
{#header_open|Non-exhaustive enum#}
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
A non-exhaustive enum can be created by adding a trailing {#syntax#}_{#endsyntax#} field.
The enum must specify a tag type and cannot consume every enumeration value.
add non-exhaustive enum to langref
2020-01-15 21:05:52 +00:00
</p>
<p>
all: zig fmt and rename "@XToY" to "@YFromX" Signed-off-by: Eric Joldasov <bratishkaerik@getgoogleoff.me>
2023-06-15 07:14:16 +00:00
{#link|@enumFromInt#} on a non-exhaustive enum involves the safety semantics
stage1: `@intToEnum` implicitly does an `@intCast` This is a backwards-compatible language change. Previously, `@intToEnum` coerced its integer operand to the integer tag type of the destination enum type, often requiring the callsite to additionally wrap the operand in an `@intCast`. Now, the `@intCast` is implicit, and any integer operand can be passed to `@intToEnum`. The same as before, it is illegal behavior to pass any integer which does not have a corresponding enum tag.
2021-08-23 22:30:57 +00:00
of {#link|@intCast#} to the integer tag type, but beyond that always results in
a well-defined enum value.
add non-exhaustive enum to langref
2020-01-15 21:05:52 +00:00
</p>
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
A switch on a non-exhaustive enum can include a {#syntax#}_{#endsyntax#} prong as an alternative to an {#syntax#}else{#endsyntax#} prong.
With a {#syntax#}_{#endsyntax#} prong the compiler errors if all the known tag names are not handled by the switch.
add non-exhaustive enum to langref
2020-01-15 21:05:52 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_switch_non-exhaustive.zig#}
add non-exhaustive enum to langref
2020-01-15 21:05:52 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
add docs for enum literals closes #683
2019-07-04 03:09:58 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|union#}
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
<p>
A bare {#syntax#}union{#endsyntax#} defines a set of possible types that a value
can be as a list of fields. Only one field can be active at a time.
The in-memory representation of bare unions is not guaranteed.
Bare unions cannot be used to reinterpret memory. For that, use {#link|@ptrCast#},
or use an {#link|extern union#} or a {#link|packed union#} which have
guaranteed in-memory layout.
{#link|Accessing the non-active field|Wrong Union Field Access#} is
safety-checked {#link|Undefined Behavior#}:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_wrong_union_access.zig#}
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
<p>You can activate another field by assigning the entire union:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_simple_union.zig#}
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
<p>
In order to use {#link|switch#} with a union, it must be a {#link|Tagged union#}.
</p>
docs: mention `@unionInit` in the union section
2019-07-05 18:10:50 +00:00
<p>
To initialize a union when the tag is a {#link|comptime#}-known name, see {#link|@unionInit#}.
</p>
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
{#header_open|Tagged union#}
<p>Unions can be declared with an enum tag type.
This turns the union into a <em>tagged</em> union, which makes it eligible
remove @TagType
2021-01-11 18:04:38 +00:00
to use with {#link|switch#} expressions.
langref: make "Type Coercion" subsections more consistent In the "Type Coercion" section, rename: - Coercion Float to Int => Float to Int - unions and enums => Unions and Enums - tuples to arrays => Tuples to Arrays
2023-01-25 08:26:41 +00:00
Tagged unions coerce to their tag type: {#link|Type Coercion: Unions and Enums#}.
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_tagged_union.zig#}
update docs regarding enums and unions
2017-12-04 06:42:02 +00:00
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
<p>In order to modify the payload of a tagged union in a switch expression,
place a {#syntax#}*{#endsyntax#} before the variable name to make it a pointer:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_switch_modify_tagged_union.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
<p>
Unions can be made to infer the enum tag type.
Further, unions can have methods just like structs and enums.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_union_method.zig#}
add docs for union methods
2018-04-08 22:03:02 +00:00
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
<p>
{#link|@tagName#} can be used to return a {#link|comptime#}
tagName: return a null-terminated slice
2021-04-27 22:57:28 +00:00
{#syntax#}[:0]const u8{#endsyntax#} value representing the field name:
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_tagName.zig#}
update docs regarding enums and unions
2017-12-04 06:42:02 +00:00
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
{#header_close#}
{#header_open|extern union#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
An {#syntax#}extern union{#endsyntax#} has memory layout guaranteed to be compatible with
the target C ABI.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
{#see_also|extern struct#}
{#header_close#}
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
{#header_open|packed union#}
<p>A {#syntax#}packed union{#endsyntax#} has well-defined in-memory layout and is eligible
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
to be in a {#link|packed struct#}.</p>
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
{#header_close#}
update docs for anonymous struct/list literals
2019-11-12 00:57:57 +00:00
{#header_open|Anonymous Union Literals#}
<p>{#link|Anonymous Struct Literals#} syntax can be used to initialize unions without specifying
the type:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_anonymous_union.zig#}
update docs for anonymous struct/list literals
2019-11-12 00:57:57 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
langref cleanups * move the opaque section to after struct, enum, union, and add hyperlinks * improve the introduction of the zig build system. don't link to the wiki. * update to the latest zig init-exe example code * rename headers to avoid redundant words such as "zig" * simplify example code
2020-10-17 04:29:33 +00:00
{#header_open|opaque#}
<p>
{#syntax#}opaque {}{#endsyntax#} declares a new type with an unknown (but non-zero) size and alignment.
It can contain declarations the same as {#link|structs|struct#}, {#link|unions|union#},
and {#link|enums|enum#}.
</p>
<p>
This is typically used for type safety when interacting with C code that does not expose struct details.
Example:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_opaque.zig#}
langref cleanups * move the opaque section to after struct, enum, union, and add hyperlinks * improve the introduction of the zig build system. don't link to the wiki. * update to the latest zig init-exe example code * rename headers to avoid redundant words such as "zig" * simplify example code
2020-10-17 04:29:33 +00:00
{#header_close#}
langref: mention `void{}` and empty blocks closes #11112 closes #12496
2022-10-30 23:27:02 +00:00
{#header_open|Blocks#}
langref: document labeled blocks, labeled for, labeled while closes #1327
2018-08-28 00:59:28 +00:00
<p>
Blocks are used to limit the scope of variable declarations:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_blocks.zig#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>Blocks are expressions. When labeled, {#syntax#}break{#endsyntax#} can be used
langref: document labeled blocks, labeled for, labeled while closes #1327
2018-08-28 00:59:28 +00:00
to return a value from the block:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_labeled_break.zig#}
langref: document labeled blocks, labeled for, labeled while closes #1327
2018-08-28 00:59:28 +00:00
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>Here, {#syntax#}blk{#endsyntax#} can be any name.</p>
langref: document labeled blocks, labeled for, labeled while closes #1327
2018-08-28 00:59:28 +00:00
{#see_also|Labeled while|Labeled for#}
docs: shadowing closes #1245
2019-02-18 22:49:26 +00:00
{#header_open|Shadowing#}
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
<p>{#link|Identifiers#} are never allowed to "hide" other identifiers by using the same name:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_shadowing.zig#}
docs: shadowing closes #1245
2019-02-18 22:49:26 +00:00
<p>
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
Because of this, when you read Zig code you can always rely on an identifier to consistently mean
the same thing within the scope it is defined. Note that you can, however, use the same name if
Minor rewording of "Shadowing" section within language reference
2021-10-23 04:13:35 +00:00
the scopes are separate:
docs: shadowing closes #1245
2019-02-18 22:49:26 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_scopes.zig#}
langref: document labeled blocks, labeled for, labeled while closes #1327
2018-08-28 00:59:28 +00:00
{#header_close#}
langref: mention `void{}` and empty blocks closes #11112 closes #12496
2022-10-30 23:27:02 +00:00
{#header_open|Empty Blocks#}
<p>An empty block is equivalent to {#syntax#}void{}{#endsyntax#}:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_empty_block.zig#}
langref: mention `void{}` and empty blocks closes #11112 closes #12496
2022-10-30 23:27:02 +00:00
{#header_close#}
docs: shadowing closes #1245
2019-02-18 22:49:26 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|switch#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_switch.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
<p>
{#syntax#}switch{#endsyntax#} can be used to capture the field values
of a {#link|Tagged union#}. Modifications to the field values can be
done by placing a {#syntax#}*{#endsyntax#} before the capture variable name,
turning it into a pointer.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_switch_tagged_union.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|comptime|enum|@compileError|Compile Variables#}
add docs for enum literals closes #683
2019-07-04 03:09:58 +00:00
{#header_open|Exhaustive Switching#}
<p>
When a {#syntax#}switch{#endsyntax#} expression does not have an {#syntax#}else{#endsyntax#} clause,
it must exhaustively list all the possible values. Failure to do so is a compile error:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_unhandled_enumeration_value.zig#}
add docs for enum literals closes #683
2019-07-04 03:09:58 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
add docs for enum literals closes #683
2019-07-04 03:09:58 +00:00
{#header_open|Switching with Enum Literals#}
<p>
{#link|Enum Literals#} can be useful to use with {#syntax#}switch{#endsyntax#} to avoid
repetitively specifying {#link|enum#} or {#link|union#} types:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_exhaustive_switch.zig#}
add docs for enum literals closes #683
2019-07-04 03:09:58 +00:00
Labeled switch documentation (#21383) Add langref docs for labeled switch This feature was proposed in #8220, and implemented in #21257. Co-authored-by: Andrew Kelley <andrew@ziglang.org>
2024-09-13 03:06:49 +00:00
{#header_close#}
{#header_open|Labeled switch#}
<p>
When a switch statement is labeled, it can be referenced from a
{#syntax#}break{#endsyntax#} or {#syntax#}continue{#endsyntax#}.
{#syntax#}break{#endsyntax#} will return a value from the {#syntax#}
switch{#endsyntax#}.
</p>
<p>
A {#syntax#}continue{#endsyntax#} targeting a switch must have an
operand. When executed, it will jump to the matching prong, as if the
{#syntax#}switch{#endsyntax#} were executed again with the {#syntax#}
continue{#endsyntax#}'s operand replacing the initial switch value.
</p>
{#code|test_switch_continue.zig#}
<p>
Semantically, this is equivalent to the following loop:
</p>
{#code|test_switch_continue_equivalent.zig#}
<p>
This can improve clarity of (for example) state machines, where the syntax {#syntax#}continue :sw .next_state{#endsyntax#} is unambiguous, explicit, and immediately understandable.
</p>
<p>
However, the motivating example is a switch on each element of an array, where using a single switch can improve clarity and performance:
</p>
{#code|test_switch_dispatch_loop.zig#}
<p>
If the operand to {#syntax#}continue{#endsyntax#} is
{#link|comptime#}-known, then it can be lowered to an unconditional branch
to the relevant case. Such a branch is perfectly predicted, and hence
typically very fast to execute.
</p>
<p>
If the operand is runtime-known, each {#syntax#}continue{#endsyntax#} can
embed a conditional branch inline (ideally through a jump table), which
allows a CPU to predict its target independently of any other prong. A
loop-based lowering would force every branch through the same dispatch
point, hindering branch prediction.
</p>
add docs for enum literals closes #683
2019-07-04 03:09:58 +00:00
{#header_close#}
langref: document inline switch
2022-09-27 14:38:01 +00:00
langref: explicitly mention inline combined with multiple cases closes #18524
2024-01-21 23:11:20 +00:00
{#header_open|Inline Switch Prongs#}
langref: document inline switch
2022-09-27 14:38:01 +00:00
<p>
Switch prongs can be marked as {#syntax#}inline{#endsyntax#} to generate
langref: explicitly mention inline combined with multiple cases closes #18524
2024-01-21 23:11:20 +00:00
the prong's body for each possible value it could have, making the
captured value {#link|comptime#}.
langref: document inline switch
2022-09-27 14:38:01 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_inline_switch.zig#}
langref: document inline switch
2022-09-27 14:38:01 +00:00
langref: explicitly mention inline combined with multiple cases closes #18524
2024-01-21 23:11:20 +00:00
<p>The {#syntax#}inline{#endsyntax#} keyword may also be combined with ranges:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|inline_prong_range.zig#}
langref: document inline switch
2022-09-27 14:38:01 +00:00
<p>
{#syntax#}inline else{#endsyntax#} prongs can be used as a type safe
alternative to {#syntax#}inline for{#endsyntax#} loops:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_inline_else.zig#}
langref: document inline switch
2022-09-27 14:38:01 +00:00
<p>
When using an inline prong switching on an union an additional
capture can be used to obtain the union's enum tag value.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_inline_switch_union_tag.zig#}
langref: document inline switch
2022-09-27 14:38:01 +00:00
{#see_also|inline while|inline for#}
{#header_close#}
add docs for enum literals closes #683
2019-07-04 03:09:58 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|while#}
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
<p>
A while loop is used to repeatedly execute an expression until
some condition is no longer true.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_while.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Use {#syntax#}break{#endsyntax#} to exit a while loop early.
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_while_break.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Use {#syntax#}continue{#endsyntax#} to jump back to the beginning of the loop.
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_while_continue.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
<p>
While loops support a continue expression which is executed when the loop
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
is continued. The {#syntax#}continue{#endsyntax#} keyword respects this expression.
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_while_continue_expression.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
<p>
While loops are expressions. The result of the expression is the
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
result of the {#syntax#}else{#endsyntax#} clause of a while loop, which is executed when
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
the condition of the while loop is tested as false.
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}break{#endsyntax#}, like {#syntax#}return{#endsyntax#}, accepts a value
parameter. This is the result of the {#syntax#}while{#endsyntax#} expression.
When you {#syntax#}break{#endsyntax#} from a while loop, the {#syntax#}else{#endsyntax#} branch is not
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
evaluated.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_while_else.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: document labeled blocks, labeled for, labeled while closes #1327
2018-08-28 00:59:28 +00:00
{#header_open|Labeled while#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>When a {#syntax#}while{#endsyntax#} loop is labeled, it can be referenced from a {#syntax#}break{#endsyntax#}
or {#syntax#}continue{#endsyntax#} from within a nested loop:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_while_nested_break.zig#}
langref: document labeled blocks, labeled for, labeled while closes #1327
2018-08-28 00:59:28 +00:00
{#header_close#}
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
{#header_open|while with Optionals#}
<p>
Just like {#link|if#} expressions, while loops can take an optional as the
condition and capture the payload. When {#link|null#} is encountered the loop
exits.
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
When the {#syntax#}|x|{#endsyntax#} syntax is present on a {#syntax#}while{#endsyntax#} expression,
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
the while condition must have an {#link|Optional Type#}.
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
The {#syntax#}else{#endsyntax#} branch is allowed on optional iteration. In this case, it will
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
be executed on the first null value encountered.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_while_null_capture.zig#}
error sets - update langref. all tests passing
2018-02-08 08:02:41 +00:00
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
{#header_close#}
{#header_open|while with Error Unions#}
<p>
Just like {#link|if#} expressions, while loops can take an error union as
the condition and capture the payload or the error code. When the
condition results in an error code the else branch is evaluated and
the loop is finished.
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
When the {#syntax#}else |x|{#endsyntax#} syntax is present on a {#syntax#}while{#endsyntax#} expression,
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
the while condition must have an {#link|Error Union Type#}.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_while_error_capture.zig#}
langref: improve docs for while and undefined closes #1190
2018-07-03 18:03:27 +00:00
{#header_close#}
langref: organize docs for inline loops and add note about when to use it
2018-06-19 21:21:08 +00:00
{#header_open|inline while#}
<p>
While loops can be inlined. This causes the loop to be unrolled, which
allows the code to do some things which only work at compile time,
such as use types as first class values.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_inline_while.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: organize docs for inline loops and add note about when to use it
2018-06-19 21:21:08 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
It is recommended to use {#syntax#}inline{#endsyntax#} loops only for one of these reasons:
langref: organize docs for inline loops and add note about when to use it
2018-06-19 21:21:08 +00:00
</p>
<ul>
<li>You need the loop to execute at {#link|comptime#} for the semantics to work.</li>
<li>
You have a benchmark to prove that forcibly unrolling the loop in this way is measurably faster.
</li>
</ul>
{#header_close#}
breaking syntax change: ??x to x.? (#1095) See #1023 This also renames Nullable/Maybe to Optional
2018-06-10 03:42:14 +00:00
{#see_also|if|Optionals|Errors|comptime|unreachable#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|for#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_for.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: document labeled blocks, labeled for, labeled while closes #1327
2018-08-28 00:59:28 +00:00
{#header_open|Labeled for#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>When a {#syntax#}for{#endsyntax#} loop is labeled, it can be referenced from a {#syntax#}break{#endsyntax#}
or {#syntax#}continue{#endsyntax#} from within a nested loop:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_for_nested_break.zig#}
langref: document labeled blocks, labeled for, labeled while closes #1327
2018-08-28 00:59:28 +00:00
{#header_close#}
langref: organize docs for inline loops and add note about when to use it
2018-06-19 21:21:08 +00:00
{#header_open|inline for#}
<p>
For loops can be inlined. This causes the loop to be unrolled, which
allows the code to do some things which only work at compile time,
such as use types as first class values.
The capture value and iterator value of inlined for loops are
compile-time known.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_inline_for.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: organize docs for inline loops and add note about when to use it
2018-06-19 21:21:08 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
It is recommended to use {#syntax#}inline{#endsyntax#} loops only for one of these reasons:
langref: organize docs for inline loops and add note about when to use it
2018-06-19 21:21:08 +00:00
</p>
<ul>
<li>You need the loop to execute at {#link|comptime#} for the semantics to work.</li>
<li>
You have a benchmark to prove that forcibly unrolling the loop in this way is measurably faster.
</li>
</ul>
{#header_close#}
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|while|comptime|Arrays|Slices#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|if#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_if.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Add comment. Split up if docs for optionals.
2023-12-07 21:51:03 +00:00
{#header_open|if with Optionals#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_if_optionals.zig#}
langref: Expand "if error union with optional" test case Follow-up to #5818, closes #5819
2020-07-08 20:40:16 +00:00
Add comment. Split up if docs for optionals.
2023-12-07 21:51:03 +00:00
{#header_close#}
breaking syntax change: ??x to x.? (#1095) See #1023 This also renames Nullable/Maybe to Optional
2018-06-10 03:42:14 +00:00
{#see_also|Optionals|Errors#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#header_open|defer#}
langref: extract code comments into paragraphs Related #18496
2024-01-19 04:55:44 +00:00
<p>Executes an expression unconditionally at scope exit.</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_defer.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: extract code comments into paragraphs Related #18496
2024-01-19 04:55:44 +00:00
<p>Defer expressions are evaluated in reverse order.</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|defer_unwind.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: extract code comments into paragraphs Related #18496
2024-01-19 04:55:44 +00:00
<p>Inside a defer expression the return statement is not allowed.</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_invalid_defer.zig#}
langref: improve the defer section Split the original `defer.zig` doctest into 3 doctest: 1. Document the defer keyword 2. Document that the return statement is not allowed inside a defer expression 3. Document the errdefer keyword Replace "method" with "expression" in the text `defer method`.
2022-12-11 16:40:36 +00:00
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|Errors#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|unreachable#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Docs: clarify unreachable for ReleaseSmall
2022-09-28 10:30:55 +00:00
In {#link|Debug#} and {#link|ReleaseSafe#} mode
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}unreachable{#endsyntax#} emits a call to {#syntax#}panic{#endsyntax#} with the message <code>reached unreachable code</code>.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
Docs: clarify unreachable for ReleaseSmall
2022-09-28 10:30:55 +00:00
In {#link|ReleaseFast#} and {#link|ReleaseSmall#} mode, the optimizer uses the assumption that {#syntax#}unreachable{#endsyntax#} code
will never be hit to perform optimizations.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Basics#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_unreachable.zig#}
Use std.testing.expect in language reference samples In this commit, the code samples in the language reference have been changed to use `std.testing.expect` rather than `std.debug.assert` when they are written in `test` code. This will teach Zig learners best practices when they write their own test code. Not all uses of `std.debug.assert` have been replaced. There are examples where using `assert` fits the context of the sample. Using `std.debug.assert` in test code can lead to errors if running tests in ReleaseFast mode. In ReleaseFast mode, the `unreachable` in `assert` is undefined behavior. It is possible that `assert` always causes `zig test` to pass thus possibly leading to incorrect test code outcomes. The goal is to prevent incorrect code from passing test cases. Closes #5836
2020-07-11 02:27:26 +00:00
<p>In fact, this is how {#syntax#}std.debug.assert{#endsyntax#} is implemented:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_assertion_failure.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|At Compile-Time#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_unreachable.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|Zig Test|Build Mode|comptime#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_close#}
{#header_open|noreturn#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}noreturn{#endsyntax#} is the type of:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>{#syntax#}break{#endsyntax#}</li>
<li>{#syntax#}continue{#endsyntax#}</li>
<li>{#syntax#}return{#endsyntax#}</li>
<li>{#syntax#}unreachable{#endsyntax#}</li>
<li>{#syntax#}while (true) {}{#endsyntax#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>When resolving types together, such as {#syntax#}if{#endsyntax#} clauses or {#syntax#}switch{#endsyntax#} prongs,
the {#syntax#}noreturn{#endsyntax#} type is compatible with every other type. Consider:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_noreturn.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
<p>Another use case for {#syntax#}noreturn{#endsyntax#} is the {#syntax#}exit{#endsyntax#} function:</p>
{#code|test_noreturn_from_exit.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
improve detection of how to execute binaries on the host `getExternalExecutor` is moved from `std.zig.CrossTarget` to `std.zig.system.NativeTargetInfo.getExternalExecutor`. The function also now communicates a bit more information about *why* the host is unable to execute a binary. The CLI is updated to report this information in a useful manner. `getExternalExecutor` is also improved to detect such patterns as: * x86_64 is able to execute x86 binaries * aarch64 is able to execute arm binaries * etc. Added qemu-hexagon support to `getExternalExecutor`. `std.Target.canExecBinaries` of is removed; callers should use the more powerful `getExternalExecutor` instead. Now that `zig test` tries to run the resulting binary no matter what, this commit has a follow-up change to the build system and docgen to utilize the `getExternalExecutor` function and pass `--test-no-exec` in some cases to avoid getting the error. Additionally: * refactor: extract NativePaths and NativeTargetInfo into their own files named after the structs. * small improvement to langref to reduce the complexity of the `callconv` expression in a couple examples.
2021-12-03 04:51:14 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Functions#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_functions.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
make self-hosted the default compiler stage1 is available behind the -fstage1 flag. closes #89
2022-08-08 06:10:57 +00:00
<p>There is a difference between a function <em>body</em> and a function <em>pointer</em>.
Function bodies are {#link|comptime#}-only types while function {#link|Pointers#} may be
runtime-known.</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Pass-by-value Parameters#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: clarify passing aggregate types as parameters
2019-02-05 15:28:05 +00:00
Primitive types such as {#link|Integers#} and {#link|Floats#} passed as parameters
are copied, and then the copy is available in the function body. This is called "passing by value".
Copying a primitive type is essentially free and typically involves nothing more than
setting a register.
</p>
<p>
Structs, unions, and arrays can sometimes be more efficiently passed as a reference, since a copy
could be arbitrarily expensive depending on the size. When these types are passed
as parameters, Zig may choose to copy and pass by value, or pass by reference, whichever way
Zig decides will be faster. This is made possible, in part, by the fact that parameters are immutable.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_pass_by_reference_or_value.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
allow passing by non-copying value closes #733
2018-06-14 02:40:38 +00:00
For extern functions, Zig follows the C ABI for passing structs and unions by value.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
Add documentation on function parameter type inference.
2019-10-11 08:41:21 +00:00
{#header_close#}
{#header_open|Function Parameter Type Inference#}
Rename @typeOf to @TypeOf in the language reference
2019-12-09 20:59:42 +00:00
<p>
add 'anytype' to stage1 and langref
2020-07-11 11:08:20 +00:00
Function parameters can be declared with {#syntax#}anytype{#endsyntax#} in place of the type.
Add documentation on function parameter type inference.
2019-10-11 08:41:21 +00:00
In this case the parameter types will be inferred when the function is called.
Rename @typeOf to @TypeOf in the language reference
2019-12-09 20:59:42 +00:00
Use {#link|@TypeOf#} and {#link|@typeInfo#} to get information about the inferred type.
Add documentation on function parameter type inference.
2019-10-11 08:41:21 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_fn_type_inference.zig#}
Add documentation on function parameter type inference.
2019-10-11 08:41:21 +00:00
Rename @typeOf to @TypeOf in the language reference
2019-12-09 20:59:42 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
langref: document inline functions
2024-01-11 02:31:28 +00:00
{#header_open|inline fn#}
<p>
Adding the {#syntax#}inline{#endsyntax#} keyword to a function definition makes that
function become <em>semantically inlined</em> at the callsite. This is
not a hint to be possibly observed by optimization passes, but has
implications on the types and values involved in the function call.
</p>
<p>
Unlike normal function calls, arguments at an inline function callsite which are
compile-time known are treated as {#link|Compile Time Parameters#}. This can potentially
propagate all the way to the return value:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|inline_call.zig#}
langref: document inline functions
2024-01-11 02:31:28 +00:00
<p>If {#syntax#}inline{#endsyntax#} is removed, the test fails with the compile error
instead of passing.</p>
<p>It is generally better to let the compiler decide when to inline a
function, except for these scenarios:</p>
<ul>
<li>To change how many stack frames are in the call stack, for debugging purposes.</li>
langref: fix typo
2024-01-11 09:02:21 +00:00
<li>To force comptime-ness of the arguments to propagate to the return value of the function, as in the above example.</li>
langref: document inline functions
2024-01-11 02:31:28 +00:00
<li>Real world performance measurements demand it.</li>
</ul>
<p>Note that {#syntax#}inline{#endsyntax#} actually <em>restricts</em>
what the compiler is allowed to do. This can harm binary size,
compilation speed, and even runtime performance.</p>
{#header_close#}
add some docs for reflection
2018-01-31 16:47:56 +00:00
{#header_open|Function Reflection#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_fn_reflection.zig#}
langref: improve the test_fn_reflection.zig doctest Currently, the test_fn_reflection.zig doctest has an example of .Fn.is_var_args. This example can confuse the reader, since there is no documentation about variadic functions and is_var_args is mainly used in the compiler. Remove the example with .Fn.is_var_args and add instead examples with .Fn.return_type and .Fn.is_generic.
2022-12-12 08:03:51 +00:00
add some docs for reflection
2018-01-31 16:47:56 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Errors#}
update errors section of docs closes #768
2018-02-24 01:43:47 +00:00
{#header_open|Error Set Type#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
update errors section of docs closes #768
2018-02-24 01:43:47 +00:00
An error set is like an {#link|enum#}.
However, each error name across the entire compilation gets assigned an unsigned integer
greater than 0. You are allowed to declare the same error name more than once, and if you do, it
gets assigned the same integer value.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
langref: update to document --error-limit flag
2023-10-19 21:32:44 +00:00
The error set type defaults to a {#syntax#}u16{#endsyntax#}, though if the maximum number of distinct
error values is provided via the <kbd>--error-limit [num]</kbd> command line parameter an integer type
with the minimum number of bits required to represent all of the error values will be used.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
You can {#link|coerce|Type Coercion#} an error from a subset to a superset:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_coerce_error_subset_to_superset.zig#}
update errors section of docs closes #768
2018-02-24 01:43:47 +00:00
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
But you cannot {#link|coerce|Type Coercion#} an error from a superset to a subset:
update errors section of docs closes #768
2018-02-24 01:43:47 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_coerce_error_superset_to_subset.zig#}
update errors section of docs closes #768
2018-02-24 01:43:47 +00:00
<p>
There is a shortcut for declaring an error set with only 1 value, and then getting that value:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|single_value_error_set_shortcut.zig#}
update errors section of docs closes #768
2018-02-24 01:43:47 +00:00
<p>This is equivalent to:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|single_value_error_set.zig#}
update errors section of docs closes #768
2018-02-24 01:43:47 +00:00
<p>
This becomes useful when using {#link|Inferred Error Sets#}.
</p>
{#header_open|The Global Error Set#}
docs: fix some incorrect error documentation
2018-11-19 18:20:39 +00:00
<p>{#syntax#}anyerror{#endsyntax#} refers to the global error set.
update errors section of docs closes #768
2018-02-24 01:43:47 +00:00
This is the error set that contains all errors in the entire compilation unit.
It is a superset of all other error sets and a subset of none of them.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
You can {#link|coerce|Type Coercion#} any error set to the global one, and you can explicitly
docs: fix some incorrect error documentation
2018-11-19 18:20:39 +00:00
cast an error of the global error set to a non-global one. This inserts a language-level
update errors section of docs closes #768
2018-02-24 01:43:47 +00:00
assert to make sure the error value is in fact in the destination error set.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
doc: fix typo and tighten wording in error sections Changes: - Removed superfluous "when possible" - Fixed typo in "documentationt" - Added missing comma - Moved definition of error union type up to first sentence
2018-03-25 22:48:07 +00:00
The global error set should generally be avoided because it prevents the
compiler from knowing what errors are possible at compile-time. Knowing
the error set at compile-time is better for generated documentation and
helpful error messages, such as forgetting a possible error value in a {#link|switch#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
update errors section of docs closes #768
2018-02-24 01:43:47 +00:00
{#header_close#}
{#header_close#}
{#header_open|Error Union Type#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
An error set type and normal type can be combined with the {#syntax#}!{#endsyntax#}
doc: fix typo and tighten wording in error sections Changes: - Removed superfluous "when possible" - Fixed typo in "documentationt" - Added missing comma - Moved definition of error union type up to first sentence
2018-03-25 22:48:07 +00:00
binary operator to form an error union type. You are likely to use an
error union type more often than an error set type by itself.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
Here is a function to parse a string into a 64-bit integer:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|error_union_parsing_u64.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Notice the return type is {#syntax#}!u64{#endsyntax#}. This means that the function
error sets - update langref. all tests passing
2018-02-08 08:02:41 +00:00
either returns an unsigned 64 bit integer, or an error. We left off the error set
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
to the left of the {#syntax#}!{#endsyntax#}, so the error set is inferred.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
Within the function definition, you can see some return statements that return
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
an error, and at the bottom a return statement that returns a {#syntax#}u64{#endsyntax#}.
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
Both types {#link|coerce|Type Coercion#} to {#syntax#}anyerror!u64{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
What it looks like to use this function varies depending on what you're
trying to do. One of the following:
</p>
<ul>
<li>You want to provide a default value if it returned an error.</li>
<li>If it returned an error then you want to return the same error.</li>
<li>You know with complete certainty it will not return an error, so want to unconditionally unwrap it.</li>
<li>You want to take a different action for each possible error.</li>
</ul>
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
{#header_open|catch#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>If you want to provide a default value, you can use the {#syntax#}catch{#endsyntax#} binary operator:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|catch.zig#}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
In this code, {#syntax#}number{#endsyntax#} will be equal to the successfully parsed string, or
a default value of 13. The type of the right hand side of the binary {#syntax#}catch{#endsyntax#} operator must
match the unwrapped error union type, or be of type {#syntax#}noreturn{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
Two more examples of possible syntax when dealing with errors (#15042) Add an example of if with try without else switch; add example of catch with block returning value
2023-03-23 09:06:46 +00:00
<p>
If you want to provide a default value with
{#syntax#}catch{#endsyntax#} after performing some logic, you
can combine {#syntax#}catch{#endsyntax#} with named {#link|Blocks#}:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|handle_error_with_catch_block.zig.zig#}
Two more examples of possible syntax when dealing with errors (#15042) Add an example of if with try without else switch; add example of catch with block returning value
2023-03-23 09:06:46 +00:00
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
{#header_close#}
{#header_open|try#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>Let's say you wanted to return the error if you got one, otherwise continue with the
function logic:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|catch_err_return.zig#}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
There is a shortcut for this. The {#syntax#}try{#endsyntax#} expression:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|try.zig#}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}try{#endsyntax#} evaluates an error union expression. If it is an error, it returns
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
from the current function with the same error. Otherwise, the expression results in
the unwrapped value.
</p>
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
{#header_close#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Maybe you know with complete certainty that an expression will never be an error.
In this case you can do this:
</p>
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#syntax#}const number = parseU64("1234", 10) catch unreachable;{#endsyntax#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Here we know for sure that "1234" will parse successfully. So we put the
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}unreachable{#endsyntax#} value on the right hand side. {#syntax#}unreachable{#endsyntax#} generates
langref: add missing ReleaseSmall when describing unreachable (#13909) Add a missing ReleaseSmall when describing unreachable in the try section and the unreachable entry in the Keyword Reference section. Additionally, transform Debug, ReleaseSafe, ReleaseFast and ReleaseSmall into links in the try section. Co-authored-by: Andrew Kelley <andrew@ziglang.org>
2022-12-13 20:02:17 +00:00
a panic in {#link|Debug#} and {#link|ReleaseSafe#} modes and undefined behavior in
{#link|ReleaseFast#} and {#link|ReleaseSmall#} modes. So, while we're debugging the
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
application, if there <em>was</em> a surprise error here, the application would crash
appropriately.
</p>
<p>
Langref: Add example for catching some errors and narrowing the error set
2023-06-21 21:39:14 +00:00
You may want to take a different action for every situation. For that, we combine
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
the {#link|if#} and {#link|switch#} expression:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#syntax_block|zig|handle_all_error_scenarios.zig#}
syntax: functions require return type. remove `->` The purpose of this is: * Only one way to do things * Changing a function with void return type to return a possible error becomes a 1 character change, subtly encouraging people to use errors. See #632 Here are some imperfect sed commands for performing this update: remove arrow: ``` sed -i 's/\(\bfn\b.*\)-> /\1/g' $(find . -name "*.zig") ``` add void: ``` sed -i 's/\(\bfn\b.*\))\s*{/\1) void {/g' $(find ../ -name "*.zig") ``` Some cleanup may be necessary, but this should do the bulk of the work.
2018-01-25 09:10:11 +00:00
fn doAThing(str: []u8) void {
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
if (parseU64(str, 10)) |number| {
doSomethingWithNumber(number);
} else |err| switch (err) {
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
error.Overflow => {
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
// handle overflow...
},
// we promise that InvalidChar won't happen (or crash in debug mode if it does)
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
error.InvalidChar => unreachable,
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
}
Langref: Add example for catching some errors and narrowing the error set
2023-06-21 21:39:14 +00:00
}
{#end_syntax_block#}
<p>
Finally, you may want to handle only some errors. For that, you can capture the unhandled
errors in the {#syntax#}else{#endsyntax#} case, which now contains a narrower error set:
</p>
{#syntax_block|zig|handle_some_error_scenarios.zig#}
langref: Fix example typo
2024-04-05 13:01:17 +00:00
fn doAnotherThing(str: []u8) error{InvalidChar}!void {
Langref: Add example for catching some errors and narrowing the error set
2023-06-21 21:39:14 +00:00
if (parseU64(str, 10)) |number| {
doSomethingWithNumber(number);
} else |err| switch (err) {
error.Overflow => {
// handle overflow...
},
else => |leftover_err| return leftover_err,
}
Two more examples of possible syntax when dealing with errors (#15042) Add an example of if with try without else switch; add example of catch with block returning value
2023-03-23 09:06:46 +00:00
}
{#end_syntax_block#}
<p>
You must use the variable capture syntax. If you don't need the
variable, you can capture with {#syntax#}_{#endsyntax#} and avoid the
{#syntax#}switch{#endsyntax#}.
</p>
{#syntax_block|zig|handle_no_error_scenarios.zig#}
fn doADifferentThing(str: []u8) void {
if (parseU64(str, 10)) |number| {
doSomethingWithNumber(number);
} else |_| {
// do as you'd like
}
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#end_syntax_block#}
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
{#header_open|errdefer#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
The other component to error handling is defer statements.
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
In addition to an unconditional {#link|defer#}, Zig has {#syntax#}errdefer{#endsyntax#},
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
which evaluates the deferred expression on block exit path if and only if
the function returned with an error from the block.
</p>
<p>
Example:
</p>
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#syntax_block|zig|errdefer_example.zig#}
error sets - update langref. all tests passing
2018-02-08 08:02:41 +00:00
fn createFoo(param: i32) !Foo {
replace `%return` with `try` See #632 better fits the convention of using keywords for control flow
2018-01-07 21:51:46 +00:00
const foo = try tryToAllocateFoo();
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
// now we have allocated foo. we need to free it if the function fails.
// but we want to return it if the function succeeds.
replace %defer with errdefer See #632 now we have 1 less sigil
2018-01-24 04:08:09 +00:00
errdefer deallocateFoo(foo);
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
breaking syntax change: orelse keyword instead of ?? (#1096) use the `zig-fmt-optional-default` branch to have zig fmt automatically do the changes. closes #1023
2018-06-10 05:13:51 +00:00
const tmp_buf = allocateTmpBuffer() orelse return error.OutOfMemory;
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
// tmp_buf is truly a temporary resource, and we for sure want to clean it up
// before this block leaves scope
defer deallocateTmpBuffer(tmp_buf);
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
if (param > 1337) return error.InvalidParam;
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
replace %defer with errdefer See #632 now we have 1 less sigil
2018-01-24 04:08:09 +00:00
// here the errdefer will not run since we're returning success from the function.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
// but the defer will run!
return foo;
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#end_syntax_block#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
The neat thing about this is that you get robust error handling without
the verbosity and cognitive overhead of trying to make sure every exit path
is covered. The deallocation code is always directly following the allocation code.
</p>
langref: add example for errdefer |err| sytnax
2024-06-28 12:32:56 +00:00
<p>
The {#syntax#}errdefer{#endsyntax#} statement can optionally capture the error:
</p>
{#code|test_errdefer_capture.zig#}
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
{#header_close#}
Add documentation for common mistakes in errdefer scoping
2022-02-23 12:33:51 +00:00
{#header_open|Common errdefer Slip-Ups#}
<p>
It should be noted that {#syntax#}errdefer{#endsyntax#} statements only last until the end of the block
they are written in, and therefore are not run if an error is returned outside of that block:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_errdefer_slip_ups.zig#}
Add documentation for common mistakes in errdefer scoping
2022-02-23 12:33:51 +00:00
<p>
To ensure that {#syntax#}deallocateFoo{#endsyntax#} is properly called
when returning an error, you must add an {#syntax#}errdefer{#endsyntax#} outside of the block:
langref: fix unclosed and lonely tag (#14250)
2023-01-10 23:02:29 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_errdefer_block.zig#}
Add documentation for common mistakes in errdefer scoping
2022-02-23 12:33:51 +00:00
<p>
The fact that errdefers only last for the block they are declared in is
especially important when using loops:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_errdefer_loop_leak.zig#}
Add documentation for common mistakes in errdefer scoping
2022-02-23 12:33:51 +00:00
<p>
Special care must be taken with code that allocates in a loop
to make sure that no memory is leaked when returning an error:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_errdefer_loop.zig#}
Add documentation for common mistakes in errdefer scoping
2022-02-23 12:33:51 +00:00
{#header_close#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
A couple of other tidbits about error handling:
</p>
<ul>
<li>These primitives give enough expressiveness that it's completely practical
to have failing to check for an error be a compile error. If you really want
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
to ignore the error, you can add {#syntax#}catch unreachable{#endsyntax#} and
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
get the added benefit of crashing in Debug and ReleaseSafe modes if your assumption was wrong.
</li>
<li>
Since Zig understands error types, it can pre-weight branches in favor of
Fixed typos
2018-11-16 18:33:58 +00:00
errors not occurring. Just a small optimization benefit that is not available
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
in other languages.
</li>
</ul>
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|defer|if|switch#}
update errors section of docs closes #768
2018-02-24 01:43:47 +00:00
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>An error union is created with the {#syntax#}!{#endsyntax#} binary operator.
add some docs for reflection
2018-01-31 16:47:56 +00:00
You can use compile-time reflection to access the child type of an error union:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_error_union.zig#}
add some docs for reflection
2018-01-31 16:47:56 +00:00
add docs and missing test case for merging error sets See #367
2018-06-12 23:38:59 +00:00
{#header_open|Merging Error Sets#}
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Use the {#syntax#}||{#endsyntax#} operator to merge two error sets together. The resulting
add docs and missing test case for merging error sets See #367
2018-06-12 23:38:59 +00:00
error set contains the errors of both error sets. Doc comments from the left-hand
side override doc comments from the right-hand side. In this example, the doc
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
comments for {#syntax#}C.PathNotFound{#endsyntax#} is <code>A doc comment</code>.
add docs and missing test case for merging error sets See #367
2018-06-12 23:38:59 +00:00
</p>
<p>
This is especially useful for functions which return different error sets depending
on {#link|comptime#} branches. For example, the Zig standard library uses
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}LinuxFileOpenError || WindowsFileOpenError{#endsyntax#} for the error set of opening
add docs and missing test case for merging error sets See #367
2018-06-12 23:38:59 +00:00
files.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_merging_error_sets.zig#}
add docs and missing test case for merging error sets See #367
2018-06-12 23:38:59 +00:00
{#header_close#}
update errors section of docs closes #768
2018-02-24 01:43:47 +00:00
{#header_open|Inferred Error Sets#}
doc fixups
2018-05-25 00:59:19 +00:00
<p>
Because many functions in Zig return a possible error, Zig supports inferring the error set.
langref: define the inferred error set syntax more explicitly This edit allows the reader to understand the syntax this section is talking about more quickly – they don’t have to read the whole code block and understand which part of it demonstrates the feature being described. Affects https://ziglang.org/documentation/master/#Inferred-Error-Sets
2021-09-12 17:08:56 +00:00
To infer the error set for a function, prepend the {#syntax#}!{#endsyntax#} operator to the function’s return type, like {#syntax#}!T{#endsyntax#}:
doc fixups
2018-05-25 00:59:19 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_inferred_error_sets.zig#}
doc fixups
2018-05-25 00:59:19 +00:00
<p>
When a function has an inferred error set, that function becomes generic and thus it becomes
trickier to do certain things with it, such as obtain a function pointer, or have an error
set that is consistent across different build targets. Additionally, inferred error sets
are incompatible with recursion.
</p>
<p>
In these situations, it is recommended to use an explicit error set. You can generally start
with an empty error set and let compile errors guide you toward completing the set.
</p>
<p>
These limitations may be overcome in a future version of Zig.
</p>
add some docs for reflection
2018-01-31 16:47:56 +00:00
{#header_close#}
update errors section of docs closes #768
2018-02-24 01:43:47 +00:00
{#header_close#}
{#header_open|Error Return Traces#}
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
<p>
Error Return Traces show all the points in the code that an error was returned to the calling function. This makes it practical to use {#link|try#} everywhere and then still be able to know what happened if an error ends up bubbling all the way out of your application.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|error_return_trace.zig#}
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
<p>
Look closely at this example. This is no stack trace.
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
You can see that the final error bubbled up was {#syntax#}PermissionDenied{#endsyntax#},
but the original error that started this whole thing was {#syntax#}FileNotFound{#endsyntax#}. In the {#syntax#}bar{#endsyntax#} function, the code handles the original error code,
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
and then returns another one, from the switch statement. Error Return Traces make this clear, whereas a stack trace would look like this:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|stack_trace.zig#}
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
<p>
Here, the stack trace does not explain how the control
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
flow in {#syntax#}bar{#endsyntax#} got to the {#syntax#}hello(){#endsyntax#} call.
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
One would have to open a debugger or further instrument the application
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
in order to find out. The error return trace, on the other hand,
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
shows exactly how the error bubbled up.
</p>
<p>
This debugging feature makes it easier to iterate quickly on code that
robustly handles all error conditions. This means that Zig developers
will naturally find themselves writing correct, robust code in order
to increase their development pace.
</p>
<p>
Error Return Traces are enabled by default in {#link|Debug#} and {#link|ReleaseSafe#} builds and disabled by default in {#link|ReleaseFast#} and {#link|ReleaseSmall#} builds.
</p>
<p>
There are a few ways to activate this error return tracing feature:
</p>
<ul>
<li>Return an error from main</li>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>An error makes its way to {#syntax#}catch unreachable{#endsyntax#} and you have not overridden the default panic handler</li>
<li>Use {#link|errorReturnTrace#} to access the current return trace. You can use {#syntax#}std.debug.dumpStackTrace{#endsyntax#} to print it. This function returns comptime-known {#link|null#} when building without error return tracing support.</li>
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
</ul>
{#header_open|Implementation Details#}
<p>
To analyze performance cost, there are two cases:
</p>
<ul>
<li>when no errors are returned</li>
<li>when returning errors</li>
</ul>
<p>
New Zig formal grammar (#1685) Reverted #1628 and changed the grammar+parser of the language to not allow certain expr where types are expected
2018-11-13 13:08:37 +00:00
For the case when no errors are returned, the cost is a single memory write operation, only in the first non-failable function in the call graph that calls a failable function, i.e. when a function returning {#syntax#}void{#endsyntax#} calls a function returning {#syntax#}error{#endsyntax#}.
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
This is to initialize this struct in the stack memory:
</p>
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#syntax_block|zig|stack_trace_struct.zig#}
New Zig formal grammar (#1685) Reverted #1628 and changed the grammar+parser of the language to not allow certain expr where types are expected
2018-11-13 13:08:37 +00:00
pub const StackTrace = struct {
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
index: usize,
instruction_addresses: [N]usize,
};
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#end_syntax_block#}
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
<p>
Here, N is the maximum function call depth as determined by call graph analysis. Recursion is ignored and counts for 2.
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
A pointer to {#syntax#}StackTrace{#endsyntax#} is passed as a secret parameter to every function that can return an error, but it's always the first parameter, so it can likely sit in a register and stay there.
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
</p>
<p>
That's it for the path when no errors occur. It's practically free in terms of performance.
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
When generating the code for a function that returns an error, just before the {#syntax#}return{#endsyntax#} statement (only for the {#syntax#}return{#endsyntax#} statements that return errors), Zig generates a call to this function:
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
</p>
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#syntax_block|zig|zig_return_error_fn.zig#}
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
// marked as "no-inline" in LLVM IR
fn __zig_return_error(stack_trace: *StackTrace) void {
stack_trace.instruction_addresses[stack_trace.index] = @returnAddress();
stack_trace.index = (stack_trace.index + 1) % N;
}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#end_syntax_block#}
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
<p>
The cost is 2 math operations plus some memory reads and writes. The memory accessed is constrained and should remain cached for the duration of the error return bubbling.
</p>
<p>
As for code size cost, 1 function call before a return statement is no big deal. Even so,
I have <a href="https://github.com/ziglang/zig/issues/690">a plan</a> to make the call to
New Zig formal grammar (#1685) Reverted #1628 and changed the grammar+parser of the language to not allow certain expr where types are expected
2018-11-13 13:08:37 +00:00
{#syntax#}__zig_return_error{#endsyntax#} a tail call, which brings the code size cost down to actually zero. What is a return statement in code without error return tracing can become a jump instruction in code with error return tracing.
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
</p>
{#header_close#}
add some docs for reflection
2018-01-31 16:47:56 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
breaking syntax change: ??x to x.? (#1095) See #1023 This also renames Nullable/Maybe to Optional
2018-06-10 03:42:14 +00:00
{#header_open|Optionals#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
One area that Zig provides safety without compromising efficiency or
breaking syntax change: ??x to x.? (#1095) See #1023 This also renames Nullable/Maybe to Optional
2018-06-10 03:42:14 +00:00
readability is with the optional type.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
breaking syntax change: ??x to x.? (#1095) See #1023 This also renames Nullable/Maybe to Optional
2018-06-10 03:42:14 +00:00
The question mark symbolizes the optional type. You can convert a type to an optional
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
type by putting a question mark in front of it, like this:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|optional_integer.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Now the variable {#syntax#}optional_int{#endsyntax#} could be an {#syntax#}i32{#endsyntax#}, or {#syntax#}null{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
Instead of integers, let's talk about pointers. Null references are the source of many runtime
exceptions, and even stand accused of being
<a href="https://www.lucidchart.com/techblog/2015/08/31/the-worst-mistake-of-computer-science/">the worst mistake of computer science</a>.
</p>
<p>Zig does not have them.</p>
<p>
breaking syntax change: ??x to x.? (#1095) See #1023 This also renames Nullable/Maybe to Optional
2018-06-10 03:42:14 +00:00
Instead, you can use an optional pointer. This secretly compiles down to a normal pointer,
since we know we can use 0 as the null value for the optional type. But the compiler
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
can check your work and make sure you don't assign null to something that can't be null.
</p>
<p>
Typically the downside of not having null is that it makes the code more verbose to
write. But, let's compare some equivalent C code and Zig code.
</p>
<p>
Task: call malloc, if the result is null, return null.
</p>
<p>C code</p>
langref: always start code on a separate line in a syntax_block In a syntax_block the code always start on a separate code, expect for C, JavaScript, Peg and with Zig inline assembly. Ensure that the code starts on a separate line, even in cases where there is only one line. Ensure that the end_syntax_block is always on a separate line and that the indentation is consistent.
2023-01-19 11:33:00 +00:00
{#syntax_block|c|call_malloc_in_c.c#}
// malloc prototype included for reference
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
void *malloc(size_t size);
struct Foo *do_a_thing(void) {
char *ptr = malloc(1234);
if (!ptr) return NULL;
// ...
langref: always start code on a separate line in a syntax_block In a syntax_block the code always start on a separate code, expect for C, JavaScript, Peg and with Zig inline assembly. Ensure that the code starts on a separate line, even in cases where there is only one line. Ensure that the end_syntax_block is always on a separate line and that the indentation is consistent.
2023-01-19 11:33:00 +00:00
}
{#end_syntax_block#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>Zig code</p>
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#syntax_block|zig|call_malloc_from_zig.zig#}
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
// malloc prototype included for reference
langref: fix malloc return type
2023-11-04 10:17:44 +00:00
extern fn malloc(size: usize) ?[*]u8;
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
use * for pointer type instead of & See #770 To help automatically translate code, see the zig-fmt-pointer-reform-2 branch. This will convert all & into *. Due to the syntax ambiguity (which is why we are making this change), even address-of & will turn into *, so you'll have to manually fix thes instances. You will be guaranteed to get compile errors for them - expected 'type', found 'foo'
2018-05-31 14:56:59 +00:00
fn doAThing() ?*Foo {
breaking syntax change: orelse keyword instead of ?? (#1096) use the `zig-fmt-optional-default` branch to have zig fmt automatically do the changes. closes #1023
2018-06-10 05:13:51 +00:00
const ptr = malloc(1234) orelse return null;
langref: fix unused vars
2021-06-23 18:32:28 +00:00
_ = ptr; // ...
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#end_syntax_block#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Here, Zig is at least as convenient, if not more, than C. And, the type of "ptr"
langref: fix malloc return type
2023-11-04 10:17:44 +00:00
is {#syntax#}[*]u8{#endsyntax#} <em>not</em> {#syntax#}?[*]u8{#endsyntax#}. The {#syntax#}orelse{#endsyntax#} keyword
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
unwrapped the optional type and therefore {#syntax#}ptr{#endsyntax#} is guaranteed to be non-null everywhere
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
it is used in the function.
</p>
<p>
The other form of checking against NULL you might see looks like this:
</p>
langref: always start code on a separate line in a syntax_block In a syntax_block the code always start on a separate code, expect for C, JavaScript, Peg and with Zig inline assembly. Ensure that the code starts on a separate line, even in cases where there is only one line. Ensure that the end_syntax_block is always on a separate line and that the indentation is consistent.
2023-01-19 11:33:00 +00:00
{#syntax_block|c|checking_null_in_c.c#}
void do_a_thing(struct Foo *foo) {
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
// do some stuff
if (foo) {
do_something_with_foo(foo);
}
// do some stuff
langref: always start code on a separate line in a syntax_block In a syntax_block the code always start on a separate code, expect for C, JavaScript, Peg and with Zig inline assembly. Ensure that the code starts on a separate line, even in cases where there is only one line. Ensure that the end_syntax_block is always on a separate line and that the indentation is consistent.
2023-01-19 11:33:00 +00:00
}
{#end_syntax_block#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
In Zig you can accomplish the same thing:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|checking_null_in_zig.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Once again, the notable thing here is that inside the if block,
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}foo{#endsyntax#} is no longer an optional pointer, it is a pointer, which
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
cannot be null.
</p>
<p>
One benefit to this is that functions which take pointers as arguments can
be annotated with the "nonnull" attribute - <code>__attribute__((nonnull))</code> in
<a href="https://gcc.gnu.org/onlinedocs/gcc-4.0.0/gcc/Function-Attributes.html">GCC</a>.
The optimizer can sometimes make better decisions knowing that pointer arguments
cannot be null.
</p>
breaking syntax change: ??x to x.? (#1095) See #1023 This also renames Nullable/Maybe to Optional
2018-06-10 03:42:14 +00:00
{#header_open|Optional Type#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>An optional is created by putting {#syntax#}?{#endsyntax#} in front of a type. You can use compile-time
breaking syntax change: ??x to x.? (#1095) See #1023 This also renames Nullable/Maybe to Optional
2018-06-10 03:42:14 +00:00
reflection to access the child type of an optional:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_optional_type.zig#}
add some docs for reflection
2018-01-31 16:47:56 +00:00
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
{#header_close#}
{#header_open|null#}
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Just like {#link|undefined#}, {#syntax#}null{#endsyntax#} has its own type, and the only way to use it is to
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
cast it to a different type:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|null.zig#}
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
{#header_close#}
{#header_open|Optional Pointers#}
<p>An optional pointer is guaranteed to be the same size as a pointer. The {#syntax#}null{#endsyntax#} of
the optional is guaranteed to be address 0.</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_optional_pointer.zig#}
improve pointer documentation closes #1630
2018-10-05 02:51:36 +00:00
add some docs for reflection
2018-01-31 16:47:56 +00:00
{#header_close#}
Add cross references for optional documentation and another example of optional capture in while loop.
2023-12-07 18:53:05 +00:00
Add comment. Split up if docs for optionals.
2023-12-07 21:51:03 +00:00
{#see_also|while with Optionals|if with Optionals#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Casting#}
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
<p>
A <strong>type cast</strong> converts a value of one type to another.
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
Zig has {#link|Type Coercion#} for conversions that are known to be completely safe and unambiguous,
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
and {#link|Explicit Casts#} for conversions that one would not want to happen on accident.
There is also a third kind of type conversion called {#link|Peer Type Resolution#} for
the case when a result type must be decided given multiple operand types.
</p>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
{#header_open|Type Coercion#}
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
<p>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
Type coercion occurs when one type is expected, but different type is provided:
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_type_coercion.zig#}
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
langref: explicit cast section
2018-06-26 19:48:42 +00:00
<p>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
Type coercions are only allowed when it is completely unambiguous how to get from one type to another,
add docs for C pointers
2019-02-14 23:59:20 +00:00
and the transformation is guaranteed to be safe. There is one exception, which is {#link|C Pointers#}.
langref: explicit cast section
2018-06-26 19:48:42 +00:00
</p>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
{#header_open|Type Coercion: Stricter Qualification#}
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
<p>
Values which have the same representation at runtime can be cast to increase the strictness
of the qualifiers, no matter how nested the qualifiers are:
</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>{#syntax#}const{#endsyntax#} - non-const to const is allowed</li>
<li>{#syntax#}volatile{#endsyntax#} - non-volatile to volatile is allowed</li>
<li>{#syntax#}align{#endsyntax#} - bigger to smaller alignment is allowed </li>
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
<li>{#link|error sets|Error Set Type#} to supersets is allowed</li>
</ul>
<p>
These casts are no-ops at runtime since the value representation does not change.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_no_op_casts.zig#}
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
<p>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
In addition, pointers coerce to const optional pointers:
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_pointer_coerce_const_optional.zig#}
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
{#header_close#}
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
{#header_open|Type Coercion: Integer and Float Widening#}
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
<p>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
{#link|Integers#} coerce to integer types which can represent every value of the old type, and likewise
{#link|Floats#} coerce to float types which can represent every value of the old type.
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_integer_widening.zig#}
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
langref: explain why comptime_float cannot be divided by comptime_int Co-authored-by: Andrew Kelley <andrew@ziglang.org> Co-authored-by: Veikka Tuominen <git@vexu.eu>
2020-06-29 00:42:37 +00:00
{#header_close#}
langref: make "Type Coercion" subsections more consistent In the "Type Coercion" section, rename: - Coercion Float to Int => Float to Int - unions and enums => Unions and Enums - tuples to arrays => Tuples to Arrays
2023-01-25 08:26:41 +00:00
{#header_open|Type Coercion: Float to Int#}
langref: explain why comptime_float cannot be divided by comptime_int Co-authored-by: Andrew Kelley <andrew@ziglang.org> Co-authored-by: Veikka Tuominen <git@vexu.eu>
2020-06-29 00:42:37 +00:00
<p>
A compiler error is appropriate because this ambiguous expression leaves the compiler
two choices about the coercion.
langref: fix html error thanks tidy
2020-08-14 16:33:45 +00:00
</p>
langref: explain why comptime_float cannot be divided by comptime_int Co-authored-by: Andrew Kelley <andrew@ziglang.org> Co-authored-by: Veikka Tuominen <git@vexu.eu>
2020-06-29 00:42:37 +00:00
<ul>
make self-hosted the default compiler stage1 is available behind the -fstage1 flag. closes #89
2022-08-08 06:10:57 +00:00
<li>Cast {#syntax#}54.0{#endsyntax#} to {#syntax#}comptime_int{#endsyntax#} resulting in {#syntax#}@as(comptime_int, 10){#endsyntax#}, which is casted to {#syntax#}@as(f32, 10){#endsyntax#}</li>
<li>Cast {#syntax#}5{#endsyntax#} to {#syntax#}comptime_float{#endsyntax#} resulting in {#syntax#}@as(comptime_float, 10.8){#endsyntax#}, which is casted to {#syntax#}@as(f32, 10.8){#endsyntax#}</li>
langref: explain why comptime_float cannot be divided by comptime_int Co-authored-by: Andrew Kelley <andrew@ziglang.org> Co-authored-by: Veikka Tuominen <git@vexu.eu>
2020-06-29 00:42:37 +00:00
</ul>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_ambiguous_coercion.zig#}
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
{#header_close#}
Docs fix array/pointer/slice type coercion section (#9392) * removed deprecated coercion: [X]T => [] const T * Fixed tests and added desc for first test * Improved heading
2021-07-23 06:32:20 +00:00
{#header_open|Type Coercion: Slices, Arrays and Pointers#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_coerce_slices_arrays_and_pointers.zig#}
docs: finish initial documentation for implicit casts closes #1514
2019-03-11 23:34:58 +00:00
{#see_also|C Pointers#}
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
{#header_close#}
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
{#header_open|Type Coercion: Optionals#}
docs: finish initial documentation for implicit casts closes #1514
2019-03-11 23:34:58 +00:00
<p>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
The payload type of {#link|Optionals#}, as well as {#link|null#}, coerce to the optional type.
docs: finish initial documentation for implicit casts closes #1514
2019-03-11 23:34:58 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_coerce_optionals.zig#}
docs: finish initial documentation for implicit casts closes #1514
2019-03-11 23:34:58 +00:00
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
<p>Optionals work nested inside the {#link|Error Union Type#}, too:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_coerce_optional_wrapped_error_union.zig#}
docs: finish initial documentation for implicit casts closes #1514
2019-03-11 23:34:58 +00:00
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
{#header_close#}
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
{#header_open|Type Coercion: Error Unions#}
grammar
2019-06-09 03:49:50 +00:00
<p>The payload type of an {#link|Error Union Type#} as well as the {#link|Error Set Type#}
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
coerce to the error union type:
docs: finish initial documentation for implicit casts closes #1514
2019-03-11 23:34:58 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_coerce_to_error_union.zig#}
docs: finish initial documentation for implicit casts closes #1514
2019-03-11 23:34:58 +00:00
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
{#header_close#}
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
{#header_open|Type Coercion: Compile-Time Known Numbers#}
docs: finish initial documentation for implicit casts closes #1514
2019-03-11 23:34:58 +00:00
<p>When a number is {#link|comptime#}-known to be representable in the destination type,
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
it may be coerced:
docs: finish initial documentation for implicit casts closes #1514
2019-03-11 23:34:58 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_coerce_large_to_small.zig#}
docs: finish initial documentation for implicit casts closes #1514
2019-03-11 23:34:58 +00:00
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
{#header_close#}
langref: make "Type Coercion" subsections more consistent In the "Type Coercion" section, rename: - Coercion Float to Int => Float to Int - unions and enums => Unions and Enums - tuples to arrays => Tuples to Arrays
2023-01-25 08:26:41 +00:00
{#header_open|Type Coercion: Unions and Enums#}
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
<p>Tagged unions can be coerced to enums, and enums can be coerced to tagged unions
docs: finish initial documentation for implicit casts closes #1514
2019-03-11 23:34:58 +00:00
when they are {#link|comptime#}-known to be a field of the union that has only one possible value, such as
{#link|void#}:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_coerce_unions_enums.zig#}
langref: improve test_coerce_unions_enums.zig Add more coercion examples to test_coerce_unions_enums.zig in the "Type Coercion: unions and enums" section.
2023-01-24 15:11:38 +00:00
docs: finish initial documentation for implicit casts closes #1514
2019-03-11 23:34:58 +00:00
{#see_also|union|enum#}
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
{#header_close#}
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
{#header_open|Type Coercion: undefined#}
Document tuple syntax Closes #13837
2022-12-10 03:10:55 +00:00
<p>{#link|undefined#} can be coerced to any type.</p>
{#header_close#}
langref: make "Type Coercion" subsections more consistent In the "Type Coercion" section, rename: - Coercion Float to Int => Float to Int - unions and enums => Unions and Enums - tuples to arrays => Tuples to Arrays
2023-01-25 08:26:41 +00:00
{#header_open|Type Coercion: Tuples to Arrays#}
Document tuple syntax Closes #13837
2022-12-10 03:10:55 +00:00
<p>{#link|Tuples#} can be coerced to arrays, if all of the fields have the same type.</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_coerce_tuples_arrays.zig#}
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
{#header_close#}
{#header_close#}
{#header_open|Explicit Casts#}
langref: explicit cast section
2018-06-26 19:48:42 +00:00
<p>
Explicit casts are performed via {#link|Builtin Functions#}.
Some explicit casts are safe; some are not.
Some explicit casts perform language-level assertions; some do not.
Some explicit casts are no-ops at runtime; some are not.
</p>
<ul>
<li>{#link|@bitCast#} - change type but maintain bit representation</li>
<li>{#link|@alignCast#} - make a pointer have more alignment</li>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
<li>{#link|@enumFromInt#} - obtain an enum value based on its integer tag value</li>
<li>{#link|@errorFromInt#} - obtain an error code based on its integer value</li>
Sema: add `@errorCast` which works for both error sets and error unions Closes #17343
2023-10-01 10:16:02 +00:00
<li>{#link|@errorCast#} - convert to a smaller error set</li>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
<li>{#link|@floatCast#} - convert a larger float to a smaller float</li>
<li>{#link|@floatFromInt#} - convert an integer to a float value</li>
<li>{#link|@intCast#} - convert between integer types</li>
all: zig fmt and rename "@XToY" to "@YFromX" Signed-off-by: Eric Joldasov <bratishkaerik@getgoogleoff.me>
2023-06-15 07:14:16 +00:00
<li>{#link|@intFromBool#} - convert true to 1 and false to 0</li>
<li>{#link|@intFromEnum#} - obtain the integer tag value of an enum or tagged union</li>
<li>{#link|@intFromError#} - obtain the integer value of an error code</li>
<li>{#link|@intFromFloat#} - obtain the integer part of a float value</li>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
<li>{#link|@intFromPtr#} - obtain the address of a pointer</li>
all: zig fmt and rename "@XToY" to "@YFromX" Signed-off-by: Eric Joldasov <bratishkaerik@getgoogleoff.me>
2023-06-15 07:14:16 +00:00
<li>{#link|@ptrFromInt#} - convert an address to a pointer</li>
langref: explicit cast section
2018-06-26 19:48:42 +00:00
<li>{#link|@ptrCast#} - convert between pointer types</li>
<li>{#link|@truncate#} - convert between integer types, chopping off bits</li>
</ul>
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
{#header_close#}
{#header_open|Peer Type Resolution#}
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
<p>Peer Type Resolution occurs in these places:</p>
<ul>
<li>{#link|switch#} expressions</li>
<li>{#link|if#} expressions</li>
<li>{#link|while#} expressions</li>
<li>{#link|for#} expressions</li>
<li>Multiple break statements in a block</li>
<li>Some {#link|binary operations|Table of Operators#}</li>
</ul>
<p>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
This kind of type resolution chooses a type that all peer types can coerce into. Here are
langref: add docs for peer type resolution closes #1367
2018-08-20 18:21:58 +00:00
some examples:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_peer_type_resolution.zig#}
langref: mention error union switch peer resolution
2023-12-08 09:16:11 +00:00
add casting docs, __extenddftf2, and __extendsftf2
2018-06-21 18:43:55 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
langref: add docs for void see #367
2018-06-18 16:02:30 +00:00
add docs for zero bit types and pointers to zero bit types closes #1561
2019-02-25 23:31:37 +00:00
{#header_open|Zero Bit Types#}
<p>For some types, {#link|@sizeOf#} is 0:</p>
<ul>
<li>{#link|void#}</li>
<li>The {#link|Integers#} {#syntax#}u0{#endsyntax#} and {#syntax#}i0{#endsyntax#}.</li>
<li>{#link|Arrays#} and {#link|Vectors#} with len 0, or with an element type that is a zero bit type.</li>
<li>An {#link|enum#} with only 1 tag.</li>
fix tiny typo in langref.html.in
2019-06-18 13:26:07 +00:00
<li>A {#link|struct#} with all fields being zero bit types.</li>
add docs for zero bit types and pointers to zero bit types closes #1561
2019-02-25 23:31:37 +00:00
<li>A {#link|union#} with only 1 field which is a zero bit type.</li>
</ul>
langref: add docs for void see #367
2018-06-18 16:02:30 +00:00
<p>
add docs for zero bit types and pointers to zero bit types closes #1561
2019-02-25 23:31:37 +00:00
These types can only ever have one possible value, and thus
require 0 bits to represent. Code that makes use of these types is
langref: add docs for void see #367
2018-06-18 16:02:30 +00:00
not included in the final generated code:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|zero_bit_types.zig#}
add docs for zero bit types and pointers to zero bit types closes #1561
2019-02-25 23:31:37 +00:00
<p>When this turns into machine code, there is no code generated in the
body of {#syntax#}entry{#endsyntax#}, even in {#link|Debug#} mode. For example, on x86_64:</p>
langref: add docs for void see #367
2018-06-18 16:02:30 +00:00
<pre><code>0000000000000010 &lt;entry&gt;:
10: 55 push %rbp
11: 48 89 e5 mov %rsp,%rbp
14: 5d pop %rbp
15: c3 retq </code></pre>
<p>These assembly instructions do not have any code associated with the void values -
Fix minor langref typos
2022-09-24 18:42:00 +00:00
they only perform the function call prologue and epilogue.</p>
add docs for zero bit types and pointers to zero bit types closes #1561
2019-02-25 23:31:37 +00:00
{#header_open|void#}
langref: add docs for void see #367
2018-06-18 16:02:30 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}void{#endsyntax#} can be useful for instantiating generic types. For example, given a
{#syntax#}Map(Key, Value){#endsyntax#}, one can pass {#syntax#}void{#endsyntax#} for the {#syntax#}Value{#endsyntax#}
type to make it into a {#syntax#}Set{#endsyntax#}:
langref: add docs for void see #367
2018-06-18 16:02:30 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_void_in_hashmap.zig#}
langref: add docs for void see #367
2018-06-18 16:02:30 +00:00
grammar
2019-06-09 03:49:50 +00:00
<p>Note that this is different from using a dummy value for the hash map value.
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
By using {#syntax#}void{#endsyntax#} as the type of the value, the hash map entry type has no value field, and
langref: add docs for void see #367
2018-06-18 16:02:30 +00:00
thus the hash map takes up less space. Further, all the code that deals with storing and loading the
value is deleted, as seen above.
</p>
<p>
Langref: replace mentions of c_void with anyopaque
2021-12-21 13:13:32 +00:00
{#syntax#}void{#endsyntax#} is distinct from {#syntax#}anyopaque{#endsyntax#}.
{#syntax#}void{#endsyntax#} has a known size of 0 bytes, and {#syntax#}anyopaque{#endsyntax#} has an unknown, but non-zero, size.
langref: add docs for void see #367
2018-06-18 16:02:30 +00:00
</p>
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
Expressions of type {#syntax#}void{#endsyntax#} are the only ones whose value can be ignored. For example, ignoring
a non-{#syntax#}void{#endsyntax#} expression is a compile error:
langref: add docs for void see #367
2018-06-18 16:02:30 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_expression_ignored.zig#}
langref: add docs for void see #367
2018-06-18 16:02:30 +00:00
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
<p>However, if the expression has type {#syntax#}void{#endsyntax#}, there will be no error. Expression results can be explicitly ignored by assigning them to {#syntax#}_{#endsyntax#}. </p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_void_ignored.zig#}
Document explicitly ignoring expression values
2018-12-10 05:50:12 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
add docs for zero bit types and pointers to zero bit types closes #1561
2019-02-25 23:31:37 +00:00
{#header_close#}
update `@unionInit` to integrate with result location semantics
2019-07-03 17:40:40 +00:00
{#header_open|Result Location Semantics#}
<p>
langref: add basic documentation of RLS
2023-11-19 17:03:25 +00:00
During compilation, every Zig expression and sub-expression is assigned optional result location
information. This information dictates what type the expression should have (its result type), and
where the resulting value should be placed in memory (its result location). The information is
optional in the sense that not every expression has this information: assignment to
{#syntax#}_{#endsyntax#}, for instance, does not provide any information about the type of an
expression, nor does it provide a concrete memory location to place it in.
update `@unionInit` to integrate with result location semantics
2019-07-03 17:40:40 +00:00
</p>
langref: add basic documentation of RLS
2023-11-19 17:03:25 +00:00
<p>
As a motivating example, consider the statement {#syntax#}const x: u32 = 42;{#endsyntax#}. The type
annotation here provides a result type of {#syntax#}u32{#endsyntax#} to the initialization expression
std: fix typos (#20560)
2024-07-09 21:25:42 +00:00
{#syntax#}42{#endsyntax#}, instructing the compiler to coerce this integer (initially of type
langref: add basic documentation of RLS
2023-11-19 17:03:25 +00:00
{#syntax#}comptime_int{#endsyntax#}) to this type. We will see more examples shortly.
</p>
<p>
This is not an implementation detail: the logic outlined above is codified into the Zig language
specification, and is the primary mechanism of type inference in the language. This system is
collectively referred to as "Result Location Semantics".
</p>
{#header_open|Result Types#}
<p>
Result types are propagated recursively through expressions where possible. For instance, if the
expression {#syntax#}&e{#endsyntax#} has result type {#syntax#}*u32{#endsyntax#}, then
{#syntax#}e{#endsyntax#} is given a result type of {#syntax#}u32{#endsyntax#}, allowing the
language to perform this coercion before taking a reference.
</p>
<p>
The result type mechanism is utilized by casting builtins such as {#syntax#}@intCast{#endsyntax#}.
Rather than taking as an argument the type to cast to, these builtins use their result type to
determine this information. The result type is often known from context; where it is not, the
{#syntax#}@as{#endsyntax#} builtin can be used to explicitly provide a result type.
</p>
<p>
We can break down the result types for each component of a simple expression as follows:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|result_type_propagation.zig#}
langref: add basic documentation of RLS
2023-11-19 17:03:25 +00:00
<p>
This result type information is useful for the aforementioned cast builtins, as well as to avoid
the construction of pre-coercion values, and to avoid the need for explicit type coercions in some
cases. The following table details how some common expressions propagate result types, where
{#syntax#}x{#endsyntax#} and {#syntax#}y{#endsyntax#} are arbitrary sub-expressions.
</p>
<div class="table-wrapper">
<table>
<thead>
<tr>
<th scope="col">Expression</th>
<th scope="col">Parent Result Type</th>
<th scope="col">Sub-expression Result Type</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">{#syntax#}const val: T = x{#endsyntax#}</th>
<td>-</td>
<td>{#syntax#}x{#endsyntax#} is a {#syntax#}T{#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}var val: T = x{#endsyntax#}</th>
<td>-</td>
<td>{#syntax#}x{#endsyntax#} is a {#syntax#}T{#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}val = x{#endsyntax#}</th>
<td>-</td>
<td>{#syntax#}x{#endsyntax#} is a {#syntax#}@TypeOf(val){#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}@as(T, x){#endsyntax#}</th>
<td>-</td>
<td>{#syntax#}x{#endsyntax#} is a {#syntax#}T{#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}&x{#endsyntax#}</th>
<td>{#syntax#}*T{#endsyntax#}</td>
<td>{#syntax#}x{#endsyntax#} is a {#syntax#}T{#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}&x{#endsyntax#}</th>
<td>{#syntax#}[]T{#endsyntax#}</td>
<td>{#syntax#}x{#endsyntax#} is some array of {#syntax#}T{#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}f(x){#endsyntax#}</th>
<td>-</td>
<td>{#syntax#}x{#endsyntax#} has the type of the first parameter of {#syntax#}f{#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}.{x}{#endsyntax#}</th>
<td>{#syntax#}T{#endsyntax#}</td>
<td>{#syntax#}x{#endsyntax#} is a {#syntax#}std.meta.FieldType(T, .@"0"){#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}.{ .a = x }{#endsyntax#}</th>
<td>{#syntax#}T{#endsyntax#}</td>
<td>{#syntax#}x{#endsyntax#} is a {#syntax#}std.meta.FieldType(T, .a){#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}T{x}{#endsyntax#}</th>
<td>-</td>
<td>{#syntax#}x{#endsyntax#} is a {#syntax#}std.meta.FieldType(T, .@"0"){#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}T{ .a = x }{#endsyntax#}</th>
<td>-</td>
<td>{#syntax#}x{#endsyntax#} is a {#syntax#}std.meta.FieldType(T, .a){#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}@Type(x){#endsyntax#}</th>
<td>-</td>
<td>{#syntax#}x{#endsyntax#} is a {#syntax#}std.builtin.Type{#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}@typeInfo(x){#endsyntax#}</th>
<td>-</td>
<td>{#syntax#}x{#endsyntax#} is a {#syntax#}type{#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}x << y{#endsyntax#}</th>
<td>-</td>
<td>{#syntax#}y{#endsyntax#} is a {#syntax#}std.math.Log2IntCeil(@TypeOf(x)){#endsyntax#}</td>
</tr>
</tbody>
</table>
</div>
{#header_close#}
{#header_open|Result Locations#}
<p>
In addition to result type information, every expression may be optionally assigned a result
location: a pointer to which the value must be directly written. This system can be used to prevent
intermediate copies when initializing data structures, which can be important for types which must
have a fixed memory address ("pinned" types).
</p>
<p>
When compiling the simple assignment expression {#syntax#}x = e{#endsyntax#}, many languages would
create the temporary value {#syntax#}e{#endsyntax#} on the stack, and then assign it to
{#syntax#}x{#endsyntax#}, potentially performing a type coercion in the process. Zig approaches this
differently. The expression {#syntax#}e{#endsyntax#} is given a result type matching the type of
{#syntax#}x{#endsyntax#}, and a result location of {#syntax#}&x{#endsyntax#}. For many syntactic
forms of {#syntax#}e{#endsyntax#}, this has no practical impact. However, it can have important
semantic effects when working with more complex syntax forms.
</p>
<p>
For instance, if the expression {#syntax#}.{ .a = x, .b = y }{#endsyntax#} has a result location of
{#syntax#}ptr{#endsyntax#}, then {#syntax#}x{#endsyntax#} is given a result location of
{#syntax#}&ptr.a{#endsyntax#}, and {#syntax#}y{#endsyntax#} a result location of {#syntax#}&ptr.b{#endsyntax#}.
Without this system, this expression would construct a temporary struct value entirely on the stack, and
only then copy it to the destination address. In essence, Zig desugars the assignment
{#syntax#}foo = .{ .a = x, .b = y }{#endsyntax#} to the two statements {#syntax#}foo.a = x; foo.b = y;{#endsyntax#}.
</p>
<p>
This can sometimes be important when assigning an aggregate value where the initialization
expression depends on the previous value of the aggregate. The easiest way to demonstrate this is by
attempting to swap fields of a struct or array - the following logic looks sound, but in fact is not:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|result_location_interfering_with_swap.zig#}
langref: add basic documentation of RLS
2023-11-19 17:03:25 +00:00
<p>
The following table details how some common expressions propagate result locations, where
{#syntax#}x{#endsyntax#} and {#syntax#}y{#endsyntax#} are arbitrary sub-expressions. Note that
some expressions cannot provide meaningful result locations to sub-expressions, even if they
themselves have a result location.
</p>
<div class="table-wrapper">
<table>
<thead>
<tr>
<th scope="col">Expression</th>
<th scope="col">Result Location</th>
<th scope="col">Sub-expression Result Locations</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">{#syntax#}const val: T = x{#endsyntax#}</th>
<td>-</td>
<td>{#syntax#}x{#endsyntax#} has result location {#syntax#}&val{#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}var val: T = x{#endsyntax#}</th>
<td>-</td>
<td>{#syntax#}x{#endsyntax#} has result location {#syntax#}&val{#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}val = x{#endsyntax#}</th>
<td>-</td>
<td>{#syntax#}x{#endsyntax#} has result location {#syntax#}&val{#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}@as(T, x){#endsyntax#}</th>
<td>{#syntax#}ptr{#endsyntax#}</td>
<td>{#syntax#}x{#endsyntax#} has no result location</td>
</tr>
<tr>
<th scope="row">{#syntax#}&x{#endsyntax#}</th>
<td>{#syntax#}ptr{#endsyntax#}</td>
<td>{#syntax#}x{#endsyntax#} has no result location</td>
</tr>
<tr>
<th scope="row">{#syntax#}f(x){#endsyntax#}</th>
<td>{#syntax#}ptr{#endsyntax#}</td>
<td>{#syntax#}x{#endsyntax#} has no result location</td>
</tr>
<tr>
<th scope="row">{#syntax#}.{x}{#endsyntax#}</th>
<td>{#syntax#}ptr{#endsyntax#}</td>
<td>{#syntax#}x{#endsyntax#} has result location {#syntax#}&ptr[0]{#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}.{ .a = x }{#endsyntax#}</th>
<td>{#syntax#}ptr{#endsyntax#}</td>
<td>{#syntax#}x{#endsyntax#} has result location {#syntax#}&ptr.a{#endsyntax#}</td>
</tr>
<tr>
<th scope="row">{#syntax#}T{x}{#endsyntax#}</th>
<td>{#syntax#}ptr{#endsyntax#}</td>
<td>{#syntax#}x{#endsyntax#} has no result location (typed initializers do not propagate result locations)</td>
</tr>
<tr>
<th scope="row">{#syntax#}T{ .a = x }{#endsyntax#}</th>
<td>{#syntax#}ptr{#endsyntax#}</td>
<td>{#syntax#}x{#endsyntax#} has no result location (typed initializers do not propagate result locations)</td>
</tr>
<tr>
<th scope="row">{#syntax#}@Type(x){#endsyntax#}</th>
<td>{#syntax#}ptr{#endsyntax#}</td>
<td>{#syntax#}x{#endsyntax#} has no result location</td>
</tr>
<tr>
<th scope="row">{#syntax#}@typeInfo(x){#endsyntax#}</th>
<td>{#syntax#}ptr{#endsyntax#}</td>
<td>{#syntax#}x{#endsyntax#} has no result location</td>
</tr>
<tr>
<th scope="row">{#syntax#}x << y{#endsyntax#}</th>
<td>{#syntax#}ptr{#endsyntax#}</td>
<td>{#syntax#}x{#endsyntax#} and {#syntax#}y{#endsyntax#} do not have result locations</td>
</tr>
</tbody>
</table>
</div>
{#header_close#}
update `@unionInit` to integrate with result location semantics
2019-07-03 17:40:40 +00:00
{#header_close#}
add docs for usingnamespace closes #1589
2019-09-25 01:23:12 +00:00
{#header_open|usingnamespace#}
<p>
langref: new usingnamespace semantics
2021-09-01 00:01:57 +00:00
{#syntax#}usingnamespace{#endsyntax#} is a declaration that mixes all the public
declarations of the operand, which must be a {#link|struct#}, {#link|union#}, {#link|enum#},
or {#link|opaque#}, into the namespace:
add docs for usingnamespace closes #1589
2019-09-25 01:23:12 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_usingnamespace.zig#}
add docs for usingnamespace closes #1589
2019-09-25 01:23:12 +00:00
<p>
langref: new usingnamespace semantics
2021-09-01 00:01:57 +00:00
{#syntax#}usingnamespace{#endsyntax#} has an important use case when organizing the public
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
API of a file or package. For example, one might have <code class="file">c.zig</code> with all of the
add docs for usingnamespace closes #1589
2019-09-25 01:23:12 +00:00
{#link|C imports|Import from C Header File#}:
</p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
{#syntax_block|zig|c.zig#}
add docs for usingnamespace closes #1589
2019-09-25 01:23:12 +00:00
pub usingnamespace @cImport({
@cInclude("epoxy/gl.h");
@cInclude("GLFW/glfw3.h");
@cDefine("STBI_ONLY_PNG", "");
@cDefine("STBI_NO_STDIO", "");
@cInclude("stb_image.h");
});
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
{#end_syntax_block#}
add docs for usingnamespace closes #1589
2019-09-25 01:23:12 +00:00
<p>
The above example demonstrates using {#syntax#}pub{#endsyntax#} to qualify the
{#syntax#}usingnamespace{#endsyntax#} additionally makes the imported declarations
{#syntax#}pub{#endsyntax#}. This can be used to forward declarations, giving precise control
over what declarations a given file exposes.
</p>
{#header_close#}
langref: new usingnamespace semantics
2021-09-01 00:01:57 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|comptime#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Zig places importance on the concept of whether an expression is known at compile-time.
There are a few different places this concept is used, and these building blocks are used
to keep the language small, readable, and powerful.
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Introducing the Compile-Time Concept#}
{#header_open|Compile-Time Parameters#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Compile-time parameters is how Zig implements generics. It is compile-time duck typing.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|compile-time_duck_typing.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
In Zig, types are first-class citizens. They can be assigned to variables, passed as parameters to functions,
and returned from functions. However, they can only be used in expressions which are known at <em>compile-time</em>,
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
which is why the parameter {#syntax#}T{#endsyntax#} in the above snippet must be marked with {#syntax#}comptime{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
A {#syntax#}comptime{#endsyntax#} parameter means that:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<ul>
<li>At the callsite, the value must be known at compile-time, or it is a compile error.</li>
<li>In the function definition, the value is known at compile-time.</li>
</ul>
<p>
For example, if we were to introduce another function to the above snippet:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_unresolved_comptime_value.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
This is an error because the programmer attempted to pass a value only known at run-time
to a function which expects a value known at compile-time.
</p>
<p>
Another way to get an error is if we pass a type that violates the type checker when the
function is analyzed. This is what it means to have <em>compile-time duck typing</em>.
</p>
<p>
For example:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_mismatched_type.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
On the flip side, inside the function definition with the {#syntax#}comptime{#endsyntax#} parameter, the
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
value is known at compile-time. This means that we actually could make this work for the bool type
if we wanted to:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_max_with_bool.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
This works because Zig implicitly inlines {#syntax#}if{#endsyntax#} expressions when the condition
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
is known at compile-time, and the compiler guarantees that it will skip analysis of
the branch not taken.
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
This means that the actual function generated for {#syntax#}max{#endsyntax#} in this situation looks like
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
this:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|compiler_generated_function.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
All the code that dealt with compile-time known values is eliminated and we are left with only
the necessary run-time code to accomplish the task.
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
This works the same way for {#syntax#}switch{#endsyntax#} expressions - they are implicitly inlined
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
when the target expression is compile-time known.
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Compile-Time Variables#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
In Zig, the programmer can label variables as {#syntax#}comptime{#endsyntax#}. This guarantees to the compiler
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
that every load and store of the variable is performed at compile-time. Any violation of this results in a
compile error.
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
This combined with the fact that we can {#syntax#}inline{#endsyntax#} loops allows us to write
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
a function which is partially evaluated at compile-time and partially at run-time.
</p>
<p>
For example:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_evaluation.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
This example is a bit contrived, because the compile-time evaluation component is unnecessary;
this code would work fine if it was all done at run-time. But it does end up generating
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
different code. In this example, the function {#syntax#}performFn{#endsyntax#} is generated three different times,
for the different values of {#syntax#}prefix_char{#endsyntax#} provided:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#syntax_block|zig|performFn_1#}
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
// From the line:
Use std.testing.expect in language reference samples In this commit, the code samples in the language reference have been changed to use `std.testing.expect` rather than `std.debug.assert` when they are written in `test` code. This will teach Zig learners best practices when they write their own test code. Not all uses of `std.debug.assert` have been replaced. There are examples where using `assert` fits the context of the sample. Using `std.debug.assert` in test code can lead to errors if running tests in ReleaseFast mode. In ReleaseFast mode, the `unreachable` in `assert` is undefined behavior. It is possible that `assert` always causes `zig test` to pass thus possibly leading to incorrect test code outcomes. The goal is to prevent incorrect code from passing test cases. Closes #5836
2020-07-11 02:27:26 +00:00
// expect(performFn('t', 1) == 6);
syntax: functions require return type. remove `->` The purpose of this is: * Only one way to do things * Changing a function with void return type to return a possible error becomes a 1 character change, subtly encouraging people to use errors. See #632 Here are some imperfect sed commands for performing this update: remove arrow: ``` sed -i 's/\(\bfn\b.*\)-> /\1/g' $(find . -name "*.zig") ``` add void: ``` sed -i 's/\(\bfn\b.*\))\s*{/\1) void {/g' $(find ../ -name "*.zig") ``` Some cleanup may be necessary, but this should do the bulk of the work.
2018-01-25 09:10:11 +00:00
fn performFn(start_value: i32) i32 {
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
var result: i32 = start_value;
result = two(result);
result = three(result);
return result;
}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#end_syntax_block#}
{#syntax_block|zig|performFn_2#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
// From the line:
Use std.testing.expect in language reference samples In this commit, the code samples in the language reference have been changed to use `std.testing.expect` rather than `std.debug.assert` when they are written in `test` code. This will teach Zig learners best practices when they write their own test code. Not all uses of `std.debug.assert` have been replaced. There are examples where using `assert` fits the context of the sample. Using `std.debug.assert` in test code can lead to errors if running tests in ReleaseFast mode. In ReleaseFast mode, the `unreachable` in `assert` is undefined behavior. It is possible that `assert` always causes `zig test` to pass thus possibly leading to incorrect test code outcomes. The goal is to prevent incorrect code from passing test cases. Closes #5836
2020-07-11 02:27:26 +00:00
// expect(performFn('o', 0) == 1);
syntax: functions require return type. remove `->` The purpose of this is: * Only one way to do things * Changing a function with void return type to return a possible error becomes a 1 character change, subtly encouraging people to use errors. See #632 Here are some imperfect sed commands for performing this update: remove arrow: ``` sed -i 's/\(\bfn\b.*\)-> /\1/g' $(find . -name "*.zig") ``` add void: ``` sed -i 's/\(\bfn\b.*\))\s*{/\1) void {/g' $(find ../ -name "*.zig") ``` Some cleanup may be necessary, but this should do the bulk of the work.
2018-01-25 09:10:11 +00:00
fn performFn(start_value: i32) i32 {
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
var result: i32 = start_value;
result = one(result);
return result;
}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#end_syntax_block#}
{#syntax_block|zig|performFn_3#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
// From the line:
Use std.testing.expect in language reference samples In this commit, the code samples in the language reference have been changed to use `std.testing.expect` rather than `std.debug.assert` when they are written in `test` code. This will teach Zig learners best practices when they write their own test code. Not all uses of `std.debug.assert` have been replaced. There are examples where using `assert` fits the context of the sample. Using `std.debug.assert` in test code can lead to errors if running tests in ReleaseFast mode. In ReleaseFast mode, the `unreachable` in `assert` is undefined behavior. It is possible that `assert` always causes `zig test` to pass thus possibly leading to incorrect test code outcomes. The goal is to prevent incorrect code from passing test cases. Closes #5836
2020-07-11 02:27:26 +00:00
// expect(performFn('w', 99) == 99);
syntax: functions require return type. remove `->` The purpose of this is: * Only one way to do things * Changing a function with void return type to return a possible error becomes a 1 character change, subtly encouraging people to use errors. See #632 Here are some imperfect sed commands for performing this update: remove arrow: ``` sed -i 's/\(\bfn\b.*\)-> /\1/g' $(find . -name "*.zig") ``` add void: ``` sed -i 's/\(\bfn\b.*\))\s*{/\1) void {/g' $(find ../ -name "*.zig") ``` Some cleanup may be necessary, but this should do the bulk of the work.
2018-01-25 09:10:11 +00:00
fn performFn(start_value: i32) i32 {
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
var result: i32 = start_value;
langref: correct unnecessary uses of 'var'
2023-11-17 13:16:07 +00:00
_ = &result;
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
return result;
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#end_syntax_block#}
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
Note that this happens even in a debug build.
This is not a way to write more optimized code, but it is a way to make sure that what <em>should</em> happen
at compile-time, <em>does</em> happen at compile-time. This catches more errors and allows expressiveness
that in other languages requires using macros, generated code, or a preprocessor to accomplish.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Compile-Time Expressions#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
In Zig, it matters whether a given expression is known at compile-time or run-time. A programmer can
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
use a {#syntax#}comptime{#endsyntax#} expression to guarantee that the expression will be evaluated at compile-time.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
If this cannot be accomplished, the compiler will emit an error. For example:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_call_extern_function.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
It doesn't make sense that a program could call {#syntax#}exit(){#endsyntax#} (or any other external function)
at compile-time, so this is a compile error. However, a {#syntax#}comptime{#endsyntax#} expression does much
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
more than sometimes cause a compile error.
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Within a {#syntax#}comptime{#endsyntax#} expression:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>All variables are {#syntax#}comptime{#endsyntax#} variables.</li>
<li>All {#syntax#}if{#endsyntax#}, {#syntax#}while{#endsyntax#}, {#syntax#}for{#endsyntax#}, and {#syntax#}switch{#endsyntax#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
expressions are evaluated at compile-time, or emit a compile error if this is not possible.</li>
doc: clarifications to comptime section in langref after #14819
2023-04-15 00:19:37 +00:00
<li>All {#syntax#}return{#endsyntax#} and {#syntax#}try{#endsyntax#} expressions are invalid (unless the function itself is called at compile-time).</li>
<li>All code with runtime side effects or depending on runtime values emits a compile error.</li>
<li>All function calls cause the compiler to interpret the function at compile-time, emitting a
compile error if the function tries to do something that has global runtime side effects.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
<p>
This means that a programmer can create a function which is called both at compile-time and run-time, with
no modification to the function required.
</p>
<p>
Let's look at an example:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_fibonacci_recursion.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Imagine if we had forgotten the base case of the recursive function and tried to run the tests:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_fibonacci_comptime_overflow.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
The compiler produces an error which is a stack trace from trying to evaluate the
function at compile-time.
</p>
<p>
Luckily, we used an unsigned integer, and so when we tried to subtract 1 from 0, it triggered
undefined behavior, which is always a compile error if the compiler knows it happened.
But what would have happened if we used a signed integer?
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|fibonacci_comptime_infinite_recursion.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
langref: acknowledge design flaw in the self-hosted compiler See tracking issue #13724
2022-12-01 03:23:44 +00:00
The compiler is supposed to notice that evaluating this function at
compile-time took more than 1000 branches, and thus emits an error and
gives up. If the programmer wants to increase the budget for compile-time
computation, they can use a built-in function called
{#link|@setEvalBranchQuota#} to change the default number 1000 to
something else.
</p>
<p>
However, there is a <a href="https://github.com/ziglang/zig/issues/13724">design
flaw in the compiler</a> causing it to stack overflow instead of having the proper
behavior here. I'm terribly sorry about that. I hope to get this resolved
before the next release.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
langref: acknowledge design flaw in the self-hosted compiler See tracking issue #13724
2022-12-01 03:23:44 +00:00
What if we fix the base case, but put the wrong value in the
{#syntax#}expect{#endsyntax#} line?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_fibonacci_comptime_unreachable.zig#}
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
langref: add appendix and explain 'container' terminology
2022-11-09 08:29:50 +00:00
At {#link|container|Containers#} level (outside of any function), all expressions are implicitly
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}comptime{#endsyntax#} expressions. This means that we can use functions to
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
initialize complex static data. For example:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_container-level_comptime_expressions.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
When we compile this program, Zig generates the constants
with the answer pre-computed. Here are the lines from the generated LLVM IR:
</p>
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
<pre><code class="llvm">@0 = internal unnamed_addr constant [25 x i32] [i32 2, i32 3, i32 5, i32 7, i32 11, i32 13, i32 17, i32 19, i32 23, i32 29, i32 31, i32 37, i32 41, i32 43, i32 47, i32 53, i32 59, i32 61, i32 67, i32 71, i32 73, i32 79, i32 83, i32 89, i32 97]
@1 = internal unnamed_addr constant i32 1060</code></pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Note that we did not have to do anything special with the syntax of these functions. For example,
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
we could call the {#syntax#}sum{#endsyntax#} function as is with a slice of numbers whose length and values were
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
only known at run-time.
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_close#}
{#header_open|Generic Data Structures#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
Zig uses comptime capabilities to implement generic data structures without introducing any
special-case syntax.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
Here is an example of a generic {#syntax#}List{#endsyntax#} data structure.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|generic_data_structure.zig#}
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
That's it. It's a function that returns an anonymous {#syntax#}struct{#endsyntax#}.
For the purposes of error messages and debugging, Zig infers the name
{#syntax#}"List(i32)"{#endsyntax#} from the function name and parameters invoked when creating
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
the anonymous struct.
</p>
<p>
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
To explicitly give a type a name, we assign it to a constant.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|anonymous_struct_name.zig#}
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
In this example, the {#syntax#}Node{#endsyntax#} struct refers to itself.
This works because all top level declarations are order-independent.
As long as the compiler can determine the size of the struct, it is free to refer to itself.
In this case, {#syntax#}Node{#endsyntax#} refers to itself as a pointer, which has a
well-defined size at compile time, so it works fine.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#header_open|Case Study: print in Zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
Putting all of this together, let's see how {#syntax#}print{#endsyntax#} works in Zig.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|print.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Let's crack open the implementation of this and see how it works:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|poc_print_fn.zig#}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
This is a proof of concept implementation; the actual function in the standard library has more
formatting capabilities.
</p>
<p>
Note that this is not hard-coded into the Zig compiler; this is userland code in the standard library.
</p>
<p>
When this function is analyzed from our example code above, Zig partially evaluates the function
and emits a function that actually looks like this:
</p>
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#syntax_block|zig|Emitted print Function#}
pub fn print(self: *Writer, arg0: []const u8, arg1: i32) !void {
replace `%return` with `try` See #632 better fits the convention of using keywords for control flow
2018-01-07 21:51:46 +00:00
try self.write("here is a string: '");
try self.printValue(arg0);
try self.write("' here is a number: ");
try self.printValue(arg1);
try self.write("\n");
try self.flush();
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#end_syntax_block#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}printValue{#endsyntax#} is a function that takes a parameter of any type, and does different things depending
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
on the type:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|poc_printValue_fn.zig#}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
And now, what happens if we give too many arguments to {#syntax#}print{#endsyntax#}?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_print_too_many_args.zig#}
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Zig gives programmers the tools needed to protect themselves against their own mistakes.
</p>
<p>
Zig doesn't care whether the format argument is a string literal,
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
only that it is a compile-time known value that can be coerced to a {#syntax#}[]const u8{#endsyntax#}:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|print_comptime-known_format.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
This works fine.
</p>
<p>
Zig does not special case string formatting in the compiler and instead exposes enough power to accomplish this
task in userland. It does so without introducing another language on top of Zig, such as
a macro language or a preprocessor language. It's Zig all the way down.
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
langref: organize docs for inline loops and add note about when to use it
2018-06-19 21:21:08 +00:00
{#see_also|inline while|inline for#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Assembly#}
add docs for assembly and fix global assembly parsing Previously, global assembly was parsed expecting it to have the template syntax. However global assembly has no inputs, outputs, or clobbers, and thus does not have template syntax. This is now fixed. This commit also adds a compile error for using volatile on global assembly, since it is meaningless. closes #1515
2019-03-20 23:00:23 +00:00
<p>
For some use cases, it may be necessary to directly control the machine code generated
by Zig programs, rather than relying on Zig's code generation. For these cases, one
can use inline assembly. Here is an example of implementing Hello, World on x86_64 Linux
using inline assembly:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|inline_assembly.zig#}
add docs for assembly and fix global assembly parsing Previously, global assembly was parsed expecting it to have the template syntax. However global assembly has no inputs, outputs, or clobbers, and thus does not have template syntax. This is now fixed. This commit also adds a compile error for using volatile on global assembly, since it is meaningless. closes #1515
2019-03-20 23:00:23 +00:00
<p>
Dissecting the syntax:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|Assembly Syntax Explained.zig#}
add docs for assembly and fix global assembly parsing Previously, global assembly was parsed expecting it to have the template syntax. However global assembly has no inputs, outputs, or clobbers, and thus does not have template syntax. This is now fixed. This commit also adds a compile error for using volatile on global assembly, since it is meaningless. closes #1515
2019-03-20 23:00:23 +00:00
<p>
all: rename i386 to x86
2022-10-07 17:54:44 +00:00
For x86 and x86_64 targets, the syntax is AT&amp;T syntax, rather than the more
add docs for assembly and fix global assembly parsing Previously, global assembly was parsed expecting it to have the template syntax. However global assembly has no inputs, outputs, or clobbers, and thus does not have template syntax. This is now fixed. This commit also adds a compile error for using volatile on global assembly, since it is meaningless. closes #1515
2019-03-20 23:00:23 +00:00
popular Intel syntax. This is due to technical constraints; assembly parsing is
provided by LLVM and its support for Intel syntax is buggy and not well tested.
</p>
<p>
Some day Zig may have its own assembler. This would allow it to integrate more seamlessly
into the language, as well as be compatible with the popular NASM syntax. This documentation
section will be updated before 1.0.0 is released, with a conclusive statement about the status
of AT&amp;T vs Intel/NASM syntax.
</p>
{#header_open|Output Constraints#}
<p>
add docs for `@splat`
2019-09-19 15:14:42 +00:00
Output constraints are still considered to be unstable in Zig, and
add docs for assembly and fix global assembly parsing Previously, global assembly was parsed expecting it to have the template syntax. However global assembly has no inputs, outputs, or clobbers, and thus does not have template syntax. This is now fixed. This commit also adds a compile error for using volatile on global assembly, since it is meaningless. closes #1515
2019-03-20 23:00:23 +00:00
so
llvm 9.0.0 => llvm 10.0.0
2019-10-02 06:11:46 +00:00
<a href="http://releases.llvm.org/10.0.0/docs/LangRef.html#inline-asm-constraint-string">LLVM documentation</a>
add docs for assembly and fix global assembly parsing Previously, global assembly was parsed expecting it to have the template syntax. However global assembly has no inputs, outputs, or clobbers, and thus does not have template syntax. This is now fixed. This commit also adds a compile error for using volatile on global assembly, since it is meaningless. closes #1515
2019-03-20 23:00:23 +00:00
and
<a href="https://gcc.gnu.org/onlinedocs/gcc/Extended-Asm.html">GCC documentation</a>
must be used to understand the semantics.
</p>
<p>
Note that some breaking changes to output constraints are planned with
<a href="https://github.com/ziglang/zig/issues/215">issue #215</a>.
</p>
{#header_close#}
{#header_open|Input Constraints#}
<p>
add docs for `@splat`
2019-09-19 15:14:42 +00:00
Input constraints are still considered to be unstable in Zig, and
add docs for assembly and fix global assembly parsing Previously, global assembly was parsed expecting it to have the template syntax. However global assembly has no inputs, outputs, or clobbers, and thus does not have template syntax. This is now fixed. This commit also adds a compile error for using volatile on global assembly, since it is meaningless. closes #1515
2019-03-20 23:00:23 +00:00
so
llvm 9.0.0 => llvm 10.0.0
2019-10-02 06:11:46 +00:00
<a href="http://releases.llvm.org/10.0.0/docs/LangRef.html#inline-asm-constraint-string">LLVM documentation</a>
add docs for assembly and fix global assembly parsing Previously, global assembly was parsed expecting it to have the template syntax. However global assembly has no inputs, outputs, or clobbers, and thus does not have template syntax. This is now fixed. This commit also adds a compile error for using volatile on global assembly, since it is meaningless. closes #1515
2019-03-20 23:00:23 +00:00
and
<a href="https://gcc.gnu.org/onlinedocs/gcc/Extended-Asm.html">GCC documentation</a>
must be used to understand the semantics.
</p>
<p>
Note that some breaking changes to input constraints are planned with
<a href="https://github.com/ziglang/zig/issues/215">issue #215</a>.
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
add docs for assembly and fix global assembly parsing Previously, global assembly was parsed expecting it to have the template syntax. However global assembly has no inputs, outputs, or clobbers, and thus does not have template syntax. This is now fixed. This commit also adds a compile error for using volatile on global assembly, since it is meaningless. closes #1515
2019-03-20 23:00:23 +00:00
{#header_open|Clobbers#}
<p>
Clobbers are the set of registers whose values will not be preserved by the execution of
the assembly code. These do not include output or input registers. The special clobber
value of {#syntax#}"memory"{#endsyntax#} means that the assembly causes writes to
arbitrary undeclared memory locations - not only the memory pointed to by a declared
add docs for `@splat`
2019-09-19 15:14:42 +00:00
indirect output.
add docs for assembly and fix global assembly parsing Previously, global assembly was parsed expecting it to have the template syntax. However global assembly has no inputs, outputs, or clobbers, and thus does not have template syntax. This is now fixed. This commit also adds a compile error for using volatile on global assembly, since it is meaningless. closes #1515
2019-03-20 23:00:23 +00:00
</p>
<p>
Failure to declare the full set of clobbers for a given inline assembly
expression is unchecked {#link|Undefined Behavior#}.
</p>
{#header_close#}
{#header_open|Global Assembly#}
<p>
langref: add appendix and explain 'container' terminology
2022-11-09 08:29:50 +00:00
When an assembly expression occurs in a {#link|container|Containers#} level {#link|comptime#} block, this is
add docs for assembly and fix global assembly parsing Previously, global assembly was parsed expecting it to have the template syntax. However global assembly has no inputs, outputs, or clobbers, and thus does not have template syntax. This is now fixed. This commit also adds a compile error for using volatile on global assembly, since it is meaningless. closes #1515
2019-03-20 23:00:23 +00:00
<strong>global assembly</strong>.
</p>
<p>
This kind of assembly has different rules than inline assembly. First, {#syntax#}volatile{#endsyntax#}
is not valid because all global assembly is unconditionally included.
Second, there are no inputs, outputs, or clobbers. All global assembly is concatenated
verbatim into one long string and assembled together. There are no template substitution rules regarding
<code>%</code> as there are in inline assembly expressions.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_global_assembly.zig#}
add docs for assembly and fix global assembly parsing Previously, global assembly was parsed expecting it to have the template syntax. However global assembly has no inputs, outputs, or clobbers, and thus does not have template syntax. This is now fixed. This commit also adds a compile error for using volatile on global assembly, since it is meaningless. closes #1515
2019-03-20 23:00:23 +00:00
{#header_close#}
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Atomics#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>TODO: @atomic rmw</p>
<p>TODO: builtin atomic memory ordering enum</p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
remove `@fence` (#21585) closes #11650
2024-10-04 22:21:27 +00:00
{#see_also|@atomicLoad|@atomicStore|@atomicRmw|@cmpxchgWeak|@cmpxchgStrong#}
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
langref: add coroutines documentation See #367
2018-06-11 21:34:45 +00:00
{#header_close#}
basic docs for new async/await semantics
2019-08-15 20:46:43 +00:00
langref: eliminate dependencies on stage1 This commit removes async/await/suspend/resume from the language reference, as that feature does not yet work in the self-hosted compiler. We will be regressing this feature temporarily. Users of these language features should stick with 0.10.x with the `-fstage1` flag until they are restored. See tracking issue #6025.
2022-12-01 22:28:44 +00:00
{#header_open|Async Functions#}
langref: update async functions section
2024-04-07 21:13:03 +00:00
<p>Async functions regressed with the release of 0.11.0. Their future in
the Zig language is unclear due to multiple unsolved problems:</p>
<ul>
<li>LLVM's lack of ability to optimize them.</li>
<li>Third-party debuggers' lack of ability to debug them.</li>
<li><a href="https://github.com/ziglang/zig/issues/5913">The cancellation problem</a>.</li>
<li>Async function pointers preventing the stack size from being known.</li>
</ul>
<p>These problems are surmountable, but it will take time. The Zig team
is currently focused on other priorities.</p>
langref: add coroutines documentation See #367
2018-06-11 21:34:45 +00:00
{#header_close#}
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
langref: eliminate dependencies on stage1 This commit removes async/await/suspend/resume from the language reference, as that feature does not yet work in the self-hosted compiler. We will be regressing this feature temporarily. Users of these language features should stick with 0.10.x with the `-fstage1` flag until they are restored. See tracking issue #6025.
2022-12-01 22:28:44 +00:00
{#header_open|Builtin Functions|2col#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Builtin functions are provided by the compiler and are prefixed with <code>@</code>.
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
The {#syntax#}comptime{#endsyntax#} keyword on a parameter means that the parameter must be known
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
at compile time.
</p>
add @addrSpaceCast to langref
2022-09-16 22:24:51 +00:00
{#header_open|@addrSpaceCast#}
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
<pre>{#syntax#}@addrSpaceCast(ptr: anytype) anytype{#endsyntax#}</pre>
add @addrSpaceCast to langref
2022-09-16 22:24:51 +00:00
<p>
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
Converts a pointer from one address space to another. The new address space is inferred
based on the result type. Depending on the current target and address spaces, this cast
may be a no-op, a complex operation, or illegal. If the cast is legal, then the resulting
pointer points to the same memory location as the pointer operand. It is always valid to
cast a pointer between the same address spaces.
add @addrSpaceCast to langref
2022-09-16 22:24:51 +00:00
</p>
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@addWithOverflow#}
update uses of overflow arithmetic builtins
2022-12-21 14:40:30 +00:00
<pre>{#syntax#}@addWithOverflow(a: anytype, b: anytype) struct { @TypeOf(a, b), u1 }{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
update uses of overflow arithmetic builtins
2022-12-21 14:40:30 +00:00
Performs {#syntax#}a + b{#endsyntax#} and returns a tuple with the result and a possible overflow bit.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
{#header_open|@alignCast#}
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
<pre>{#syntax#}@alignCast(ptr: anytype) anytype{#endsyntax#}</pre>
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
<p>
langref: remove uses of old function pointer syntax
2022-09-23 09:08:30 +00:00
{#syntax#}ptr{#endsyntax#} can be {#syntax#}*T{#endsyntax#}, {#syntax#}?*T{#endsyntax#}, or {#syntax#}[]T{#endsyntax#}.
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
Changes the alignment of a pointer. The alignment to use is inferred based on the result type.
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
</p>
<p>A {#link|pointer alignment safety check|Incorrect Pointer Alignment#} is added
to the generated code to make sure the pointer is aligned as promised.</p>
{#header_close#}
{#header_open|@alignOf#}
<pre>{#syntax#}@alignOf(comptime T: type) comptime_int{#endsyntax#}</pre>
<p>
This function returns the number of bytes that this type should be aligned to
for the current target to match the C ABI. When the child type of a pointer has
this alignment, the alignment can be omitted from the type.
</p>
langref: rename incorrect expect to assert
2022-03-31 07:18:34 +00:00
<pre>{#syntax#}const assert = @import("std").debug.assert;
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
comptime {
update usage of std.testing in langref.html
2021-05-08 07:45:19 +00:00
assert(*u32 == *align(@alignOf(u32)) u32);
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
}{#endsyntax#}</pre>
<p>
The result is a target-specific compile time constant. It is guaranteed to be
less than or equal to {#link|@sizeOf(T)|@sizeOf#}.
</p>
{#see_also|Alignment#}
{#header_close#}
basic docs for new async/await semantics
2019-08-15 20:46:43 +00:00
initial docs for `@as`
2019-11-08 00:05:52 +00:00
{#header_open|@as#}
<pre>{#syntax#}@as(comptime T: type, expression) T{#endsyntax#}</pre>
<p>
Performs {#link|Type Coercion#}. This cast is allowed when the conversion is unambiguous and safe,
and is the preferred way to convert between types, whenever possible.
</p>
{#header_close#}
add @atomicLoad builtin See #174
2018-04-15 22:12:00 +00:00
{#header_open|@atomicLoad#}
langref: make more consistent * moves some langref into std.builtin doc comments * use the same way of referencing stuff from std.builtin closes #16483
2024-01-22 03:39:50 +00:00
<pre>{#syntax#}@atomicLoad(comptime T: type, ptr: *const T, comptime ordering: AtomicOrder) T{#endsyntax#}</pre>
add @atomicLoad builtin See #174
2018-04-15 22:12:00 +00:00
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
This builtin function atomically dereferences a pointer to a {#syntax#}T{#endsyntax#} and returns the value.
add @atomicLoad builtin See #174
2018-04-15 22:12:00 +00:00
</p>
<p>
langref: atomic ops are allowed on pointers Closes #6217
2020-09-04 18:41:34 +00:00
{#syntax#}T{#endsyntax#} must be a pointer, a {#syntax#}bool{#endsyntax#}, a float,
fix codegen, update docs
2020-03-11 11:29:17 +00:00
an integer or an enum.
add @atomicLoad builtin See #174
2018-04-15 22:12:00 +00:00
</p>
langref: make more consistent * moves some langref into std.builtin doc comments * use the same way of referencing stuff from std.builtin closes #16483
2024-01-22 03:39:50 +00:00
<p>{#syntax#}AtomicOrder{#endsyntax#} can be found with {#syntax#}@import("std").builtin.AtomicOrder{#endsyntax#}.</p>
remove `@fence` (#21585) closes #11650
2024-10-04 22:21:27 +00:00
{#see_also|@atomicStore|@atomicRmw||@cmpxchgWeak|@cmpxchgStrong#}
add @atomicLoad builtin See #174
2018-04-15 22:12:00 +00:00
{#header_close#}
stage2: implement `@atomicRmw` and `@atomicLoad` * langref: add some more "see also" links for atomics * Add the following AIR instructions - atomic_load - atomic_store_unordered - atomic_store_monotonic - atomic_store_release - atomic_store_seq_cst - atomic_rmw * Implement those AIR instructions in LLVM and C backends. * AstGen: make the `ty` result locations for `@atomicRmw`, `@atomicLoad`, and `@atomicStore` be `coerced_ty` to avoid unnecessary ZIR instructions when Sema will be doing the coercions redundantly. * Sema for `@atomicLoad` and `@atomicRmw` is done, however Sema for `@atomicStore` is not yet implemented. - comptime eval for `@atomicRmw` is not yet implemented. * Sema: flesh out `coerceInMemoryAllowed` a little bit more. It can now handle pointers.
2021-09-16 01:55:39 +00:00
add atomicrmw builtin function
2018-03-01 02:19:51 +00:00
{#header_open|@atomicRmw#}
langref: make more consistent * moves some langref into std.builtin doc comments * use the same way of referencing stuff from std.builtin closes #16483
2024-01-22 03:39:50 +00:00
<pre>{#syntax#}@atomicRmw(comptime T: type, ptr: *T, comptime op: AtomicRmwOp, operand: T, comptime ordering: AtomicOrder) T{#endsyntax#}</pre>
add atomicrmw builtin function
2018-03-01 02:19:51 +00:00
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
This builtin function dereferences a pointer to a {#syntax#}T{#endsyntax#} and atomically
modifies the value and returns the previous value.
add atomicrmw builtin function
2018-03-01 02:19:51 +00:00
</p>
<p>
langref: atomic ops are allowed on pointers Closes #6217
2020-09-04 18:41:34 +00:00
{#syntax#}T{#endsyntax#} must be a pointer, a {#syntax#}bool{#endsyntax#}, a float,
fix codegen, update docs
2020-03-11 11:29:17 +00:00
an integer or an enum.
add atomicrmw builtin function
2018-03-01 02:19:51 +00:00
</p>
langref: make more consistent * moves some langref into std.builtin doc comments * use the same way of referencing stuff from std.builtin closes #16483
2024-01-22 03:39:50 +00:00
<p>{#syntax#}AtomicOrder{#endsyntax#} can be found with {#syntax#}@import("std").builtin.AtomicOrder{#endsyntax#}.</p>
<p>{#syntax#}AtomicRmwOp{#endsyntax#} can be found with {#syntax#}@import("std").builtin.AtomicRmwOp{#endsyntax#}.</p>
remove `@fence` (#21585) closes #11650
2024-10-04 22:21:27 +00:00
{#see_also|@atomicStore|@atomicLoad|@cmpxchgWeak|@cmpxchgStrong#}
add atomicrmw builtin function
2018-03-01 02:19:51 +00:00
{#header_close#}
stage2: implement `@atomicRmw` and `@atomicLoad` * langref: add some more "see also" links for atomics * Add the following AIR instructions - atomic_load - atomic_store_unordered - atomic_store_monotonic - atomic_store_release - atomic_store_seq_cst - atomic_rmw * Implement those AIR instructions in LLVM and C backends. * AstGen: make the `ty` result locations for `@atomicRmw`, `@atomicLoad`, and `@atomicStore` be `coerced_ty` to avoid unnecessary ZIR instructions when Sema will be doing the coercions redundantly. * Sema for `@atomicLoad` and `@atomicRmw` is done, however Sema for `@atomicStore` is not yet implemented. - comptime eval for `@atomicRmw` is not yet implemented. * Sema: flesh out `coerceInMemoryAllowed` a little bit more. It can now handle pointers.
2021-09-16 01:55:39 +00:00
add @atomicStore builtin
2019-11-12 22:25:44 +00:00
{#header_open|@atomicStore#}
langref: make more consistent * moves some langref into std.builtin doc comments * use the same way of referencing stuff from std.builtin closes #16483
2024-01-22 03:39:50 +00:00
<pre>{#syntax#}@atomicStore(comptime T: type, ptr: *T, value: T, comptime ordering: AtomicOrder) void{#endsyntax#}</pre>
add @atomicStore builtin
2019-11-12 22:25:44 +00:00
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
This builtin function dereferences a pointer to a {#syntax#}T{#endsyntax#} and atomically stores the given value.
add @atomicStore builtin
2019-11-12 22:25:44 +00:00
</p>
<p>
langref: atomic ops are allowed on pointers Closes #6217
2020-09-04 18:41:34 +00:00
{#syntax#}T{#endsyntax#} must be a pointer, a {#syntax#}bool{#endsyntax#}, a float,
fix codegen, update docs
2020-03-11 11:29:17 +00:00
an integer or an enum.
add @atomicStore builtin
2019-11-12 22:25:44 +00:00
</p>
langref: make more consistent * moves some langref into std.builtin doc comments * use the same way of referencing stuff from std.builtin closes #16483
2024-01-22 03:39:50 +00:00
<p>{#syntax#}AtomicOrder{#endsyntax#} can be found with {#syntax#}@import("std").builtin.AtomicOrder{#endsyntax#}.</p>
remove `@fence` (#21585) closes #11650
2024-10-04 22:21:27 +00:00
{#see_also|@atomicLoad|@atomicRmw|@cmpxchgWeak|@cmpxchgStrong#}
add @atomicStore builtin
2019-11-12 22:25:44 +00:00
{#header_close#}
Add @select @select( comptime T: type, pred: std.meta.Vector(len, bool), a: std.meta.Vector(len, T), b: std.meta.Vector(len, T) ) std.meta.Vector(len, T) Constructs a vector from a & b, based on the values in the predicate vector. For indices where the predicate value is true, the corresponding element from the a vector is selected, and otherwise from b.
2021-07-26 00:37:11 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@bitCast#}
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
<pre>{#syntax#}@bitCast(value: anytype) anytype{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
Converts a value of one type to another type. The return type is the
inferred result type.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
Rename @typeOf to @TypeOf in the language reference
2019-12-09 20:59:42 +00:00
Asserts that {#syntax#}@sizeOf(@TypeOf(value)) == @sizeOf(DestType){#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
std: update `std.builtin.Type` fields to follow naming conventions The compiler actually doesn't need any functional changes for this: Sema does reification based on the tag indices of `std.builtin.Type` already! So, no zig1.wasm update is necessary. This change is necessary to disallow name clashes between fields and decls on a type, which is a prerequisite of #9938.
2024-08-28 01:35:53 +00:00
Asserts that {#syntax#}@typeInfo(DestType) != .pointer{#endsyntax#}. Use {#syntax#}@ptrCast{#endsyntax#} or {#syntax#}@ptrFromInt{#endsyntax#} if you need this.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
Can be used for these things for example:
</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>Convert {#syntax#}f32{#endsyntax#} to {#syntax#}u32{#endsyntax#} bits</li>
<li>Convert {#syntax#}i32{#endsyntax#} to {#syntax#}u32{#endsyntax#} preserving twos complement</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
<p>
langref: clarify permitted `@bitCast` usage. The current phrasing is vague; it is unclear whether it is demonstrating an example of the type of permitted behavior, from which the rule set must be extrapolated, or it is stating that this restriction only applies to the relationship between integers and bare structs.
2022-06-02 18:29:09 +00:00
Works at compile-time if {#syntax#}value{#endsyntax#} is known at compile time. It's a compile error to bitcast a value of undefined layout; this means that, besides the restriction from types which possess dedicated casting builtins (enums, pointers, error sets), bare structs, error unions, slices, optionals, and any other type without a well-defined memory layout, also cannot be used in this operation.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
fixups
2018-09-21 18:15:58 +00:00
{#header_open|@bitOffsetOf#}
different array literal syntax when inferring the size old syntax: []i32{1, 2, 3} new syntax: [_]i32{1, 2, 3} closes #1797
2019-06-09 23:24:24 +00:00
<pre>{#syntax#}@bitOffsetOf(comptime T: type, comptime field_name: []const u8) comptime_int{#endsyntax#}</pre>
fixups
2018-09-21 18:15:58 +00:00
<p>
Returns the bit offset of a field relative to its containing struct.
</p>
<p>
For non {#link|packed structs|packed struct#}, this will always be divisible by {#syntax#}8{#endsyntax#}.
For packed structs, non-byte-aligned fields will share a byte offset, but they will have different
bit offsets.
</p>
Renamed @byteOffsetOf to @offsetOf
2021-06-10 20:56:55 +00:00
{#see_also|@offsetOf#}
fixups
2018-09-21 18:15:58 +00:00
{#header_close#}
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
implement `@bitSizeOf`
2020-01-16 15:12:43 +00:00
{#header_open|@bitSizeOf#}
<pre>{#syntax#}@bitSizeOf(comptime T: type) comptime_int{#endsyntax#}</pre>
<p>
clarify @bitSizeOf behavior
2021-07-07 18:39:44 +00:00
This function returns the number of bits it takes to store {#syntax#}T{#endsyntax#} in memory if the type
were a field in a packed struct/union.
implement `@bitSizeOf`
2020-01-16 15:12:43 +00:00
The result is a target-specific compile time constant.
</p>
<p>
This function measures the size at runtime. For types that are disallowed at runtime, such as
{#syntax#}comptime_int{#endsyntax#} and {#syntax#}type{#endsyntax#}, the result is {#syntax#}0{#endsyntax#}.
</p>
{#see_also|@sizeOf|@typeInfo#}
{#header_close#}
compiler,lib,test,langref: migrate `@setCold` to `@branchHint`
2024-08-24 15:16:53 +00:00
{#header_open|@branchHint#}
<pre>{#syntax#}@branchHint(hint: BranchHint) void{#endsyntax#}</pre>
<p>Hints to the optimizer how likely a given branch of control flow is to be reached.</p>
<p>{#syntax#}BranchHint{#endsyntax#} can be found with {#syntax#}@import("std").builtin.BranchHint{#endsyntax#}.</p>
<p>This function is only valid as the first statement in a control flow branch, or the first statement in a function.</p>
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
{#header_open|@breakpoint#}
langref: add missing return types to builtin functions This should add all remaining missing return types to all builtin functions. For @clz, @ctz, and @popCount it uses anytype for the lack of a better alternative. We already use this return type for other builtin functions in the langref to indicate that the type is not always the same. It is not possible to use anytype as the return type for regular functions but builtin functions are special.
2023-03-03 15:16:08 +00:00
<pre>{#syntax#}@breakpoint() void{#endsyntax#}</pre>
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
<p>
This function inserts a platform-specific debug trap instruction which causes
debuggers to break there.
add @trap builtin This introduces a new builtin function that compiles down to something that results in an illegal instruction exception/interrupt. It can be used to exit a program abnormally. This implements the builtin for all backends.
2023-03-03 17:35:03 +00:00
Unlike for {#syntax#}@trap(){#endsyntax#}, execution may continue after this point if the program is resumed.
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
</p>
<p>
This function is only valid within function scope.
</p>
add @trap builtin This introduces a new builtin function that compiles down to something that results in an illegal instruction exception/interrupt. It can be used to exit a program abnormally. This implements the builtin for all backends.
2023-03-03 17:35:03 +00:00
{#see_also|@trap#}
stage1: add support for @mulAdd fused-multiply-add for floats and vectors of floats Not all of the softfloat library is being built.... Vector support is very buggy at the moment, but should work when the bugs are fixed. (as I had the same code working with another vector function, that hasn't been merged yet).
2019-06-18 22:28:49 +00:00
{#header_close#}
add @trap builtin This introduces a new builtin function that compiles down to something that results in an illegal instruction exception/interrupt. It can be used to exit a program abnormally. This implements the builtin for all backends.
2023-03-03 17:35:03 +00:00
stage1: add support for @mulAdd fused-multiply-add for floats and vectors of floats Not all of the softfloat library is being built.... Vector support is very buggy at the moment, but should work when the bugs are fixed. (as I had the same code working with another vector function, that hasn't been merged yet).
2019-06-18 22:28:49 +00:00
{#header_open|@mulAdd#}
<pre>{#syntax#}@mulAdd(comptime T: type, a: T, b: T, c: T) T{#endsyntax#}</pre>
<p>
fix(text): hyphenation and other fixes
2022-10-03 17:52:39 +00:00
Fused multiply-add, similar to {#syntax#}(a * b) + c{#endsyntax#}, except
stage1: add support for @mulAdd fused-multiply-add for floats and vectors of floats Not all of the softfloat library is being built.... Vector support is very buggy at the moment, but should work when the bugs are fixed. (as I had the same code working with another vector function, that hasn't been merged yet).
2019-06-18 22:28:49 +00:00
only rounds once, and is thus more accurate.
</p>
Correct @mulAdd's doc
2020-01-08 16:57:20 +00:00
<p>
add new builtin function `@tan` The reason for having `@tan` is that we already have `@sin` and `@cos` because some targets have machine code instructions for them, but in the case that the implementation needs to go into compiler-rt, sin, cos, and tan all share a common dependency which includes a table of data. To avoid duplicating this table of data, we promote tan to become a builtin alongside sin and cos. ZIR: The tag enum is at capacity so this commit moves `field_call_bind_named` to be `extended`. I measured this as one of the least used tags in the zig codebase. Fix libc math suffix for `f32` being wrong in both stage1 and stage2. stage1: add missing libc prefix for float functions.
2022-04-27 23:45:23 +00:00
Supports {#link|Floats#} and {#link|Vectors#} of floats.
Correct @mulAdd's doc
2020-01-08 16:57:20 +00:00
</p>
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
{#header_close#}
breaking changes to all bit manipulation intrinsics * `@clz`, `@ctz`, `@popCount`, `@bswap`, `@bitreverse` now have a type parameter * rename @bitreverse to @bitReverse * rename @bswap to @byteSwap Closes #2119 Closes #2120
2019-04-03 14:00:39 +00:00
{#header_open|@byteSwap#}
stage2+stage1: remove type parameter from bit builtins Closes #12529 Closes #12511 Closes #6835
2022-08-21 14:24:04 +00:00
<pre>{#syntax#}@byteSwap(operand: anytype) T{#endsyntax#}</pre>
<p>{#syntax#}@TypeOf(operand){#endsyntax#} must be an integer type or an integer vector type with bit count evenly divisible by 8.</p>
implement runtime `@byteSwap` and other fixups * update docs for `@byteSwap`. * fix hash & eql functions for ZigLLVMFnIdBswap not updated to include vector len. this was causing incorrect bswap function being called in unrelated code * fix `@byteSwap` behavior tests only testing comptime and not runtime operations * implement runtime `@byteSwap` * fix incorrect logic in ir_render_vector_to_array and ir_render_array_to_vector with regards to whether or not to bitcast * `@byteSwap` accepts an array operand which it will cast to vector * simplify `@byteSwap` semantic analysis code and various fixes
2019-09-19 04:59:04 +00:00
<p>{#syntax#}operand{#endsyntax#} may be an {#link|integer|Integers#} or {#link|vector|Vectors#}.</p>
breaking API changes to all readInt/writeInt functions & more * add `@bswap` builtin function. See #767 * comptime evaluation facilities are improved to be able to handle a `@ptrCast` with a backing array. * `@truncate` allows "truncating" a u0 value to any integer type, and the result is always comptime known to be `0`. * when specifying pointer alignment in a type expression, the alignment value of pointers which do not have addresses at runtime is ignored, and always has the default/ABI alignment * threw in a fix to freebsd/x86_64.zig to update syntax from language changes * some improvements are pending #863 closes #638 closes #1733 std lib API changes * io.InStream().readIntNe renamed to readIntNative * io.InStream().readIntLe renamed to readIntLittle * io.InStream().readIntBe renamed to readIntBig * introduced io.InStream().readIntForeign * io.InStream().readInt has parameter order changed * io.InStream().readVarInt has parameter order changed * io.InStream().writeIntNe renamed to writeIntNative * introduced io.InStream().writeIntForeign * io.InStream().writeIntLe renamed to writeIntLittle * io.InStream().writeIntBe renamed to writeIntBig * io.InStream().writeInt has parameter order changed * mem.readInt has different parameters and semantics * introduced mem.readIntNative * introduced mem.readIntForeign * mem.readIntBE renamed to mem.readIntBig and different API * mem.readIntLE renamed to mem.readIntLittle and different API * introduced mem.readIntSliceNative * introduced mem.readIntSliceForeign * introduced mem.readIntSliceLittle * introduced mem.readIntSliceBig * introduced mem.readIntSlice * mem.writeInt has different parameters and semantics * introduced mem.writeIntNative * introduced mem.writeIntForeign * mem.writeIntBE renamed to mem.readIntBig and different semantics * mem.writeIntLE renamed to mem.readIntLittle and different semantics * introduced mem.writeIntSliceForeign * introduced mem.writeIntSliceNative * introduced mem.writeIntSliceBig * introduced mem.writeIntSliceLittle * introduced mem.writeIntSlice * removed mem.endianSwapIfLe * removed mem.endianSwapIfBe * removed mem.endianSwapIf * added mem.littleToNative * added mem.bigToNative * added mem.toNative * added mem.nativeTo * added mem.nativeToLittle * added mem.nativeToBig
2018-12-13 01:19:46 +00:00
<p>
Swaps the byte order of the integer. This converts a big endian integer to a little endian integer,
and converts a little endian integer to a big endian integer.
</p>
implement runtime `@byteSwap` and other fixups * update docs for `@byteSwap`. * fix hash & eql functions for ZigLLVMFnIdBswap not updated to include vector len. this was causing incorrect bswap function being called in unrelated code * fix `@byteSwap` behavior tests only testing comptime and not runtime operations * implement runtime `@byteSwap` * fix incorrect logic in ir_render_vector_to_array and ir_render_array_to_vector with regards to whether or not to bitcast * `@byteSwap` accepts an array operand which it will cast to vector * simplify `@byteSwap` semantic analysis code and various fixes
2019-09-19 04:59:04 +00:00
<p>
Note that for the purposes of memory layout with respect to endianness, the integer type should be
related to the number of bytes reported by {#link|@sizeOf#} bytes. This is demonstrated with
{#syntax#}u24{#endsyntax#}. {#syntax#}@sizeOf(u24) == 4{#endsyntax#}, which means that a
{#syntax#}u24{#endsyntax#} stored in memory takes 4 bytes, and those 4 bytes are what are swapped on
a little vs big endian system. On the other hand, if {#syntax#}T{#endsyntax#} is specified to
be {#syntax#}u24{#endsyntax#}, then only 3 bytes are reversed.
</p>
breaking API changes to all readInt/writeInt functions & more * add `@bswap` builtin function. See #767 * comptime evaluation facilities are improved to be able to handle a `@ptrCast` with a backing array. * `@truncate` allows "truncating" a u0 value to any integer type, and the result is always comptime known to be `0`. * when specifying pointer alignment in a type expression, the alignment value of pointers which do not have addresses at runtime is ignored, and always has the default/ABI alignment * threw in a fix to freebsd/x86_64.zig to update syntax from language changes * some improvements are pending #863 closes #638 closes #1733 std lib API changes * io.InStream().readIntNe renamed to readIntNative * io.InStream().readIntLe renamed to readIntLittle * io.InStream().readIntBe renamed to readIntBig * introduced io.InStream().readIntForeign * io.InStream().readInt has parameter order changed * io.InStream().readVarInt has parameter order changed * io.InStream().writeIntNe renamed to writeIntNative * introduced io.InStream().writeIntForeign * io.InStream().writeIntLe renamed to writeIntLittle * io.InStream().writeIntBe renamed to writeIntBig * io.InStream().writeInt has parameter order changed * mem.readInt has different parameters and semantics * introduced mem.readIntNative * introduced mem.readIntForeign * mem.readIntBE renamed to mem.readIntBig and different API * mem.readIntLE renamed to mem.readIntLittle and different API * introduced mem.readIntSliceNative * introduced mem.readIntSliceForeign * introduced mem.readIntSliceLittle * introduced mem.readIntSliceBig * introduced mem.readIntSlice * mem.writeInt has different parameters and semantics * introduced mem.writeIntNative * introduced mem.writeIntForeign * mem.writeIntBE renamed to mem.readIntBig and different semantics * mem.writeIntLE renamed to mem.readIntLittle and different semantics * introduced mem.writeIntSliceForeign * introduced mem.writeIntSliceNative * introduced mem.writeIntSliceBig * introduced mem.writeIntSliceLittle * introduced mem.writeIntSlice * removed mem.endianSwapIfLe * removed mem.endianSwapIfBe * removed mem.endianSwapIf * added mem.littleToNative * added mem.bigToNative * added mem.toNative * added mem.nativeTo * added mem.nativeToLittle * added mem.nativeToBig
2018-12-13 01:19:46 +00:00
{#header_close#}
breaking changes to all bit manipulation intrinsics * `@clz`, `@ctz`, `@popCount`, `@bswap`, `@bitreverse` now have a type parameter * rename @bitreverse to @bitReverse * rename @bswap to @byteSwap Closes #2119 Closes #2120
2019-04-03 14:00:39 +00:00
{#header_open|@bitReverse#}
stage2+stage1: remove type parameter from bit builtins Closes #12529 Closes #12511 Closes #6835
2022-08-21 14:24:04 +00:00
<pre>{#syntax#}@bitReverse(integer: anytype) T{#endsyntax#}</pre>
<p>{#syntax#}@TypeOf(anytype){#endsyntax#} accepts any integer type or integer vector type.</p>
@bitreverse intrinsic, part of #767 (#1865) * bitreverse - give bswap behavior * bitreverse, comptime_ints, negative values still not working? * bitreverse working for negative comptime ints * Finished bitreverse test cases * Undo exporting a bigint function. @bitreverse test name includes ampersand * added docs entry for @bitreverse
2019-01-02 21:47:47 +00:00
<p>
Reverses the bitpattern of an integer value, including the sign bit if applicable.
</p>
<p>
For example 0b10110110 ({#syntax#}u8 = 182{#endsyntax#}, {#syntax#}i8 = -74{#endsyntax#})
becomes 0b01101101 ({#syntax#}u8 = 109{#endsyntax#}, {#syntax#}i8 = 109{#endsyntax#}).
</p>
{#header_close#}
Renamed @byteOffsetOf to @offsetOf
2021-06-10 20:56:55 +00:00
{#header_open|@offsetOf#}
<pre>{#syntax#}@offsetOf(comptime T: type, comptime field_name: []const u8) comptime_int{#endsyntax#}</pre>
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
<p>
Returns the byte offset of a field relative to its containing struct.
</p>
{#see_also|@bitOffsetOf#}
{#header_close#}
remove `@noInlineCall` from zig
2019-12-05 22:37:29 +00:00
{#header_open|@call#}
remove `stack` option from `@call`
2022-12-12 13:32:37 +00:00
<pre>{#syntax#}@call(modifier: std.builtin.CallModifier, function: anytype, args: anytype) anytype{#endsyntax#}</pre>
remove `@noInlineCall` from zig
2019-12-05 22:37:29 +00:00
<p>
Calls a function, in the same way that invoking an expression with parentheses does:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_call_builtin.zig#}
remove `@noInlineCall` from zig
2019-12-05 22:37:29 +00:00
<p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#syntax#}@call{#endsyntax#} allows more flexibility than normal function call syntax does. The
{#syntax#}CallModifier{#endsyntax#} enum is reproduced here:
</p>
{#code|builtin.CallModifier struct.zig#}
remove `@noInlineCall` from zig
2019-12-05 22:37:29 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@cDefine#}
langref builtin parameters: []u8 -> []const u8 None of these builtins modify the passed string. This parameter type can be misleading.
2023-07-21 21:03:26 +00:00
<pre>{#syntax#}@cDefine(comptime name: []const u8, value) void{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
This function can only occur inside {#syntax#}@cImport{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
This appends <code>#define $name $value</code> to the {#syntax#}@cImport{#endsyntax#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
temporary buffer.
</p>
<p>
To define without a value, like this:
</p>
<pre><code class="c">#define _GNU_SOURCE</code></pre>
<p>
Use the void value, like this:
</p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}@cDefine("_GNU_SOURCE", {}){#endsyntax#}</pre>
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|Import from C Header File|@cInclude|@cImport|@cUndef|void#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|@cImport#}
add documentation for `pub` closes #1727
2019-03-13 17:04:55 +00:00
<pre>{#syntax#}@cImport(expression) type{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
add documentation for `pub` closes #1727
2019-03-13 17:04:55 +00:00
This function parses C code and imports the functions, types, variables,
and compatible macro definitions into a new empty struct type, and then
returns that type.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}expression{#endsyntax#} is interpreted at compile time. The builtin functions
{#syntax#}@cInclude{#endsyntax#}, {#syntax#}@cDefine{#endsyntax#}, and {#syntax#}@cUndef{#endsyntax#} work
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
within this expression, appending to a temporary buffer which is then parsed as C code.
</p>
add docs recommending to only have 1 cImport
2018-02-01 01:18:47 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Usually you should only have one {#syntax#}@cImport{#endsyntax#} in your entire application, because it saves the compiler
add docs recommending to only have 1 cImport
2018-02-01 01:18:47 +00:00
from invoking clang multiple times, and prevents inline functions from being duplicated.
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Reasons for having multiple {#syntax#}@cImport{#endsyntax#} expressions would be:
add docs recommending to only have 1 cImport
2018-02-01 01:18:47 +00:00
</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>To avoid a symbol collision, for example if foo.h and bar.h both <code>#define CONNECTION_COUNT</code></li>
add docs recommending to only have 1 cImport
2018-02-01 01:18:47 +00:00
<li>To analyze the C code with different preprocessor defines</li>
</ul>
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|Import from C Header File|@cInclude|@cDefine|@cUndef#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|@cInclude#}
langref builtin parameters: []u8 -> []const u8 None of these builtins modify the passed string. This parameter type can be misleading.
2023-07-21 21:03:26 +00:00
<pre>{#syntax#}@cInclude(comptime path: []const u8) void{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
This function can only occur inside {#syntax#}@cImport{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
docs: add html lang and minor fixes
2019-12-05 21:38:59 +00:00
This appends <code>#include &lt;$path&gt;\n</code> to the {#syntax#}c_import{#endsyntax#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
temporary buffer.
</p>
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|Import from C Header File|@cImport|@cDefine|@cUndef#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@clz#}
langref: add missing return types to builtin functions This should add all remaining missing return types to all builtin functions. For @clz, @ctz, and @popCount it uses anytype for the lack of a better alternative. We already use this return type for other builtin functions in the langref to indicate that the type is not always the same. It is not possible to use anytype as the return type for regular functions but builtin functions are special.
2023-03-03 15:16:08 +00:00
<pre>{#syntax#}@clz(operand: anytype) anytype{#endsyntax#}</pre>
stage2+stage1: remove type parameter from bit builtins Closes #12529 Closes #12511 Closes #6835
2022-08-21 14:24:04 +00:00
<p>{#syntax#}@TypeOf(operand){#endsyntax#} must be an integer type or an integer vector type.</p>
Doc fixes for clz + ctz
2021-07-26 02:58:58 +00:00
<p>{#syntax#}operand{#endsyntax#} may be an {#link|integer|Integers#} or {#link|vector|Vectors#}.</p>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Improvements to docs and text * docs(std.math): elaborate on difference between absCast and absInt * docs(std.rand.Random.weightedIndex): elaborate on likelihood I think this makes it easier to understand. * langref: add small reminder * docs(std.fs.path.extension): brevity * docs(std.bit_set.StaticBitSet): mention the specific types * std.debug.TTY: explain what purpose this struct serves This should also make it clearer that this struct is not supposed to provide unrelated terminal manipulation functionality such as setting the cursor position or something because terminals are complicated and we should keep this struct simple and focused on debugging. * langref(package listing): brevity * langref: explain what exactly `threadlocal` causes to happen * std.array_list: link between swapRemove and orderedRemove Maybe this can serve as a TLDR and make it easier to decide. * PrefetchOptions.locality: clarify docs that this is a range This confused me previously and I thought I can only use either 0 or 3. * fix typos and more * std.builtin.CallingConvention: document some CCs * langref: explain possibly cryptic names I think it helps knowing what exactly these acronyms (@clz and @ctz) and abbreviations (@popCount) mean. * variadic function error: add missing preposition * std.fmt.format docs: nicely hyphenate * help menu: say what to optimize for I think this is slightly more specific than just calling it "optimizations". These are speed optimizations. I used the word "performance" here.
2023-04-23 18:06:21 +00:00
Counts the number of most-significant (leading in a big-endian sense) zeroes in an integer - "count leading zeroes".
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
Doc fixes for clz + ctz
2021-07-26 02:58:58 +00:00
If {#syntax#}operand{#endsyntax#} is a {#link|comptime#}-known integer,
fixups to the previous commit
2019-05-16 20:32:24 +00:00
the return type is {#syntax#}comptime_int{#endsyntax#}.
Doc fixes for clz + ctz
2021-07-26 02:58:58 +00:00
Otherwise, the return type is an unsigned integer or vector of unsigned integers with the minimum number
breaking changes to all bit manipulation intrinsics * `@clz`, `@ctz`, `@popCount`, `@bswap`, `@bitreverse` now have a type parameter * rename @bitreverse to @bitReverse * rename @bswap to @byteSwap Closes #2119 Closes #2120
2019-04-03 14:00:39 +00:00
of bits that can represent the bit count of the integer type.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
Doc fixes for clz + ctz
2021-07-26 02:58:58 +00:00
If {#syntax#}operand{#endsyntax#} is zero, {#syntax#}@clz{#endsyntax#} returns the bit width
fixups to the previous commit
2019-05-16 20:32:24 +00:00
of integer type {#syntax#}T{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
add @popCount intrinsic
2018-07-07 04:25:32 +00:00
{#see_also|@ctz|@popCount#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
improve cmpxchg * remove @cmpxchg, add @cmpxchgWeak and @cmpxchgStrong - See explanations in the langref. * add operand type as first parameter * return type is ?T where T is the operand type closes #461
2018-04-18 16:16:42 +00:00
{#header_open|@cmpxchgStrong#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}@cmpxchgStrong(comptime T: type, ptr: *T, expected_value: T, new_value: T, success_order: AtomicOrder, fail_order: AtomicOrder) ?T{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
This function performs a strong atomic compare-and-exchange operation, returning {#syntax#}null{#endsyntax#}
if the current value is not the given expected value. It's the equivalent of this code,
improve cmpxchg * remove @cmpxchg, add @cmpxchgWeak and @cmpxchgStrong - See explanations in the langref. * add operand type as first parameter * return type is ?T where T is the operand type closes #461
2018-04-18 16:16:42 +00:00
except atomic:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|not_atomic_cmpxchgStrong.zig#}
improve cmpxchg * remove @cmpxchg, add @cmpxchgWeak and @cmpxchgStrong - See explanations in the langref. * add operand type as first parameter * return type is ?T where T is the operand type closes #461
2018-04-18 16:16:42 +00:00
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
If you are using cmpxchg in a retry loop, {#link|@cmpxchgWeak#} is the better choice, because it can be implemented
improve cmpxchg * remove @cmpxchg, add @cmpxchgWeak and @cmpxchgStrong - See explanations in the langref. * add operand type as first parameter * return type is ?T where T is the operand type closes #461
2018-04-18 16:16:42 +00:00
more efficiently in machine instructions.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
langref: atomic ops are allowed on pointers Closes #6217
2020-09-04 18:41:34 +00:00
{#syntax#}T{#endsyntax#} must be a pointer, a {#syntax#}bool{#endsyntax#}, a float,
fix codegen, update docs
2020-03-11 11:29:17 +00:00
an integer or an enum.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
std: update `std.builtin.Type` fields to follow naming conventions The compiler actually doesn't need any functional changes for this: Sema does reification based on the tag indices of `std.builtin.Type` already! So, no zig1.wasm update is necessary. This change is necessary to disallow name clashes between fields and decls on a type, which is a prerequisite of #9938.
2024-08-28 01:35:53 +00:00
<p>{#syntax#}@typeInfo(@TypeOf(ptr)).pointer.alignment{#endsyntax#} must be {#syntax#}>= @sizeOf(T).{#endsyntax#}</p>
langref: make more consistent * moves some langref into std.builtin doc comments * use the same way of referencing stuff from std.builtin closes #16483
2024-01-22 03:39:50 +00:00
<p>{#syntax#}AtomicOrder{#endsyntax#} can be found with {#syntax#}@import("std").builtin.AtomicOrder{#endsyntax#}.</p>
remove `@fence` (#21585) closes #11650
2024-10-04 22:21:27 +00:00
{#see_also|@atomicStore|@atomicLoad|@atomicRmw|@cmpxchgWeak#}
improve cmpxchg * remove @cmpxchg, add @cmpxchgWeak and @cmpxchgStrong - See explanations in the langref. * add operand type as first parameter * return type is ?T where T is the operand type closes #461
2018-04-18 16:16:42 +00:00
{#header_close#}
stage2: implement `@atomicRmw` and `@atomicLoad` * langref: add some more "see also" links for atomics * Add the following AIR instructions - atomic_load - atomic_store_unordered - atomic_store_monotonic - atomic_store_release - atomic_store_seq_cst - atomic_rmw * Implement those AIR instructions in LLVM and C backends. * AstGen: make the `ty` result locations for `@atomicRmw`, `@atomicLoad`, and `@atomicStore` be `coerced_ty` to avoid unnecessary ZIR instructions when Sema will be doing the coercions redundantly. * Sema for `@atomicLoad` and `@atomicRmw` is done, however Sema for `@atomicStore` is not yet implemented. - comptime eval for `@atomicRmw` is not yet implemented. * Sema: flesh out `coerceInMemoryAllowed` a little bit more. It can now handle pointers.
2021-09-16 01:55:39 +00:00
improve cmpxchg * remove @cmpxchg, add @cmpxchgWeak and @cmpxchgStrong - See explanations in the langref. * add operand type as first parameter * return type is ?T where T is the operand type closes #461
2018-04-18 16:16:42 +00:00
{#header_open|@cmpxchgWeak#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}@cmpxchgWeak(comptime T: type, ptr: *T, expected_value: T, new_value: T, success_order: AtomicOrder, fail_order: AtomicOrder) ?T{#endsyntax#}</pre>
improve cmpxchg * remove @cmpxchg, add @cmpxchgWeak and @cmpxchgStrong - See explanations in the langref. * add operand type as first parameter * return type is ?T where T is the operand type closes #461
2018-04-18 16:16:42 +00:00
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
This function performs a weak atomic compare-and-exchange operation, returning {#syntax#}null{#endsyntax#}
if the current value is not the given expected value. It's the equivalent of this code,
improve cmpxchg * remove @cmpxchg, add @cmpxchgWeak and @cmpxchgStrong - See explanations in the langref. * add operand type as first parameter * return type is ?T where T is the operand type closes #461
2018-04-18 16:16:42 +00:00
except atomic:
</p>
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#syntax_block|zig|cmpxchgWeakButNotAtomic#}
use * for pointer type instead of & See #770 To help automatically translate code, see the zig-fmt-pointer-reform-2 branch. This will convert all & into *. Due to the syntax ambiguity (which is why we are making this change), even address-of & will turn into *, so you'll have to manually fix thes instances. You will be guaranteed to get compile errors for them - expected 'type', found 'foo'
2018-05-31 14:56:59 +00:00
fn cmpxchgWeakButNotAtomic(comptime T: type, ptr: *T, expected_value: T, new_value: T) ?T {
all tests passing with postfix deref syntax
2018-05-18 03:21:44 +00:00
const old_value = ptr.*;
improve cmpxchg * remove @cmpxchg, add @cmpxchgWeak and @cmpxchgStrong - See explanations in the langref. * add operand type as first parameter * return type is ?T where T is the operand type closes #461
2018-04-18 16:16:42 +00:00
if (old_value == expected_value and usuallyTrueButSometimesFalse()) {
all tests passing with postfix deref syntax
2018-05-18 03:21:44 +00:00
ptr.* = new_value;
improve cmpxchg * remove @cmpxchg, add @cmpxchgWeak and @cmpxchgStrong - See explanations in the langref. * add operand type as first parameter * return type is ?T where T is the operand type closes #461
2018-04-18 16:16:42 +00:00
return null;
} else {
return old_value;
}
}
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#end_syntax_block#}
improve cmpxchg * remove @cmpxchg, add @cmpxchgWeak and @cmpxchgStrong - See explanations in the langref. * add operand type as first parameter * return type is ?T where T is the operand type closes #461
2018-04-18 16:16:42 +00:00
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
If you are using cmpxchg in a retry loop, the sporadic failure will be no problem, and {#syntax#}cmpxchgWeak{#endsyntax#}
improve cmpxchg * remove @cmpxchg, add @cmpxchgWeak and @cmpxchgStrong - See explanations in the langref. * add operand type as first parameter * return type is ?T where T is the operand type closes #461
2018-04-18 16:16:42 +00:00
is the better choice, because it can be implemented more efficiently in machine instructions.
However if you need a stronger guarantee, use {#link|@cmpxchgStrong#}.
</p>
<p>
langref: atomic ops are allowed on pointers Closes #6217
2020-09-04 18:41:34 +00:00
{#syntax#}T{#endsyntax#} must be a pointer, a {#syntax#}bool{#endsyntax#}, a float,
fix codegen, update docs
2020-03-11 11:29:17 +00:00
an integer or an enum.
improve cmpxchg * remove @cmpxchg, add @cmpxchgWeak and @cmpxchgStrong - See explanations in the langref. * add operand type as first parameter * return type is ?T where T is the operand type closes #461
2018-04-18 16:16:42 +00:00
</p>
std: update `std.builtin.Type` fields to follow naming conventions The compiler actually doesn't need any functional changes for this: Sema does reification based on the tag indices of `std.builtin.Type` already! So, no zig1.wasm update is necessary. This change is necessary to disallow name clashes between fields and decls on a type, which is a prerequisite of #9938.
2024-08-28 01:35:53 +00:00
<p>{#syntax#}@typeInfo(@TypeOf(ptr)).pointer.alignment{#endsyntax#} must be {#syntax#}>= @sizeOf(T).{#endsyntax#}</p>
langref: make more consistent * moves some langref into std.builtin doc comments * use the same way of referencing stuff from std.builtin closes #16483
2024-01-22 03:39:50 +00:00
<p>{#syntax#}AtomicOrder{#endsyntax#} can be found with {#syntax#}@import("std").builtin.AtomicOrder{#endsyntax#}.</p>
remove `@fence` (#21585) closes #11650
2024-10-04 22:21:27 +00:00
{#see_also|@atomicStore|@atomicLoad|@atomicRmw|@cmpxchgStrong#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@compileError#}
langref builtin parameters: []u8 -> []const u8 None of these builtins modify the passed string. This parameter type can be misleading.
2023-07-21 21:03:26 +00:00
<pre>{#syntax#}@compileError(comptime msg: []const u8) noreturn{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
This function, when semantically analyzed, causes a compile error with the
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
message {#syntax#}msg{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
There are several ways that code avoids being semantically checked, such as
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
using {#syntax#}if{#endsyntax#} or {#syntax#}switch{#endsyntax#} with compile time constants,
and {#syntax#}comptime{#endsyntax#} functions.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@compileLog#}
langref: update builtin variadic functions Documentation was outdated.
2024-10-03 11:37:36 +00:00
<pre>{#syntax#}@compileLog(...) void{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
This function prints the arguments passed to it at compile-time.
</p>
<p>
To prevent accidentally leaving compile log statements in a codebase,
a compilation error is added to the build, pointing to the compile
log statement. This error prevents code from being generated, but
does not otherwise interfere with analysis.
</p>
<p>
This function can be used to do "printf debugging" on
compile-time executing code.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_compileLog_builtin.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
split `@qualCast` into `@constCast` and `@volatileCast`
2023-02-13 14:19:17 +00:00
{#header_open|@constCast#}
<pre>{#syntax#}@constCast(value: anytype) DestType{#endsyntax#}</pre>
<p>
Remove {#syntax#}const{#endsyntax#} qualifier from a pointer.
</p>
{#header_close#}
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
{#header_open|@ctz#}
langref: add missing return types to builtin functions This should add all remaining missing return types to all builtin functions. For @clz, @ctz, and @popCount it uses anytype for the lack of a better alternative. We already use this return type for other builtin functions in the langref to indicate that the type is not always the same. It is not possible to use anytype as the return type for regular functions but builtin functions are special.
2023-03-03 15:16:08 +00:00
<pre>{#syntax#}@ctz(operand: anytype) anytype{#endsyntax#}</pre>
stage2+stage1: remove type parameter from bit builtins Closes #12529 Closes #12511 Closes #6835
2022-08-21 14:24:04 +00:00
<p>{#syntax#}@TypeOf(operand){#endsyntax#} must be an integer type or an integer vector type.</p>
Doc fixes for clz + ctz
2021-07-26 02:58:58 +00:00
<p>{#syntax#}operand{#endsyntax#} may be an {#link|integer|Integers#} or {#link|vector|Vectors#}.</p>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Improvements to docs and text * docs(std.math): elaborate on difference between absCast and absInt * docs(std.rand.Random.weightedIndex): elaborate on likelihood I think this makes it easier to understand. * langref: add small reminder * docs(std.fs.path.extension): brevity * docs(std.bit_set.StaticBitSet): mention the specific types * std.debug.TTY: explain what purpose this struct serves This should also make it clearer that this struct is not supposed to provide unrelated terminal manipulation functionality such as setting the cursor position or something because terminals are complicated and we should keep this struct simple and focused on debugging. * langref(package listing): brevity * langref: explain what exactly `threadlocal` causes to happen * std.array_list: link between swapRemove and orderedRemove Maybe this can serve as a TLDR and make it easier to decide. * PrefetchOptions.locality: clarify docs that this is a range This confused me previously and I thought I can only use either 0 or 3. * fix typos and more * std.builtin.CallingConvention: document some CCs * langref: explain possibly cryptic names I think it helps knowing what exactly these acronyms (@clz and @ctz) and abbreviations (@popCount) mean. * variadic function error: add missing preposition * std.fmt.format docs: nicely hyphenate * help menu: say what to optimize for I think this is slightly more specific than just calling it "optimizations". These are speed optimizations. I used the word "performance" here.
2023-04-23 18:06:21 +00:00
Counts the number of least-significant (trailing in a big-endian sense) zeroes in an integer - "count trailing zeroes".
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
Doc fixes for clz + ctz
2021-07-26 02:58:58 +00:00
If {#syntax#}operand{#endsyntax#} is a {#link|comptime#}-known integer,
fixups to the previous commit
2019-05-16 20:32:24 +00:00
the return type is {#syntax#}comptime_int{#endsyntax#}.
Doc fixes for clz + ctz
2021-07-26 02:58:58 +00:00
Otherwise, the return type is an unsigned integer or vector of unsigned integers with the minimum number
breaking changes to all bit manipulation intrinsics * `@clz`, `@ctz`, `@popCount`, `@bswap`, `@bitreverse` now have a type parameter * rename @bitreverse to @bitReverse * rename @bswap to @byteSwap Closes #2119 Closes #2120
2019-04-03 14:00:39 +00:00
of bits that can represent the bit count of the integer type.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
Doc fixes for clz + ctz
2021-07-26 02:58:58 +00:00
If {#syntax#}operand{#endsyntax#} is zero, {#syntax#}@ctz{#endsyntax#} returns
fixups to the previous commit
2019-05-16 20:32:24 +00:00
the bit width of integer type {#syntax#}T{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
add @popCount intrinsic
2018-07-07 04:25:32 +00:00
{#see_also|@clz|@popCount#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
{#header_open|@cUndef#}
langref builtin parameters: []u8 -> []const u8 None of these builtins modify the passed string. This parameter type can be misleading.
2023-07-21 21:03:26 +00:00
<pre>{#syntax#}@cUndef(comptime name: []const u8) void{#endsyntax#}</pre>
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
<p>
This function can only occur inside {#syntax#}@cImport{#endsyntax#}.
</p>
<p>
This appends <code>#undef $name</code> to the {#syntax#}@cImport{#endsyntax#}
temporary buffer.
</p>
{#see_also|Import from C Header File|@cImport|@cDefine|@cInclude#}
{#header_close#}
implement defining C variadic functions
2022-12-12 22:14:54 +00:00
{#header_open|@cVaArg#}
<pre>{#syntax#}@cVaArg(operand: *std.builtin.VaList, comptime T: type) T{#endsyntax#}</pre>
<p>
Implements the C macro {#syntax#}va_arg{#endsyntax#}.
</p>
{#see_also|@cVaCopy|@cVaEnd|@cVaStart#}
{#header_close#}
{#header_open|@cVaCopy#}
<pre>{#syntax#}@cVaCopy(src: *std.builtin.VaList) std.builtin.VaList{#endsyntax#}</pre>
<p>
Implements the C macro {#syntax#}va_copy{#endsyntax#}.
</p>
{#see_also|@cVaArg|@cVaEnd|@cVaStart#}
{#header_close#}
{#header_open|@cVaEnd#}
<pre>{#syntax#}@cVaEnd(src: *std.builtin.VaList) void{#endsyntax#}</pre>
<p>
Implements the C macro {#syntax#}va_end{#endsyntax#}.
</p>
{#see_also|@cVaArg|@cVaCopy|@cVaStart#}
{#header_close#}
{#header_open|@cVaStart#}
<pre>{#syntax#}@cVaStart() std.builtin.VaList{#endsyntax#}</pre>
<p>
Implements the C macro {#syntax#}va_start{#endsyntax#}. Only valid inside a variadic function.
</p>
{#see_also|@cVaArg|@cVaCopy|@cVaEnd#}
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@divExact#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}@divExact(numerator: T, denominator: T) T{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Exact division. Caller guarantees {#syntax#}denominator != 0{#endsyntax#} and
{#syntax#}@divTrunc(numerator, denominator) * denominator == numerator{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>{#syntax#}@divExact(6, 3) == 2{#endsyntax#}</li>
<li>{#syntax#}@divExact(a, b) * b == a{#endsyntax#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>For a function that returns a possible error code, use {#syntax#}@import("std").math.divExact{#endsyntax#}.</p>
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|@divTrunc|@divFloor#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|@divFloor#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}@divFloor(numerator: T, denominator: T) T{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Floored division. Rounds toward negative infinity. For unsigned integers it is
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
the same as {#syntax#}numerator / denominator{#endsyntax#}. Caller guarantees {#syntax#}denominator != 0{#endsyntax#} and
std: update `std.builtin.Type` fields to follow naming conventions The compiler actually doesn't need any functional changes for this: Sema does reification based on the tag indices of `std.builtin.Type` already! So, no zig1.wasm update is necessary. This change is necessary to disallow name clashes between fields and decls on a type, which is a prerequisite of #9938.
2024-08-28 01:35:53 +00:00
{#syntax#}!(@typeInfo(T) == .int and T.is_signed and numerator == std.math.minInt(T) and denominator == -1){#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>{#syntax#}@divFloor(-5, 3) == -2{#endsyntax#}</li>
langref: fix equations
2020-10-19 02:43:34 +00:00
<li>{#syntax#}(@divFloor(a, b) * b) + @mod(a, b) == a{#endsyntax#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>For a function that returns a possible error code, use {#syntax#}@import("std").math.divFloor{#endsyntax#}.</p>
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|@divTrunc|@divExact#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|@divTrunc#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}@divTrunc(numerator: T, denominator: T) T{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Truncated division. Rounds toward zero. For unsigned integers it is
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
the same as {#syntax#}numerator / denominator{#endsyntax#}. Caller guarantees {#syntax#}denominator != 0{#endsyntax#} and
std: update `std.builtin.Type` fields to follow naming conventions The compiler actually doesn't need any functional changes for this: Sema does reification based on the tag indices of `std.builtin.Type` already! So, no zig1.wasm update is necessary. This change is necessary to disallow name clashes between fields and decls on a type, which is a prerequisite of #9938.
2024-08-28 01:35:53 +00:00
{#syntax#}!(@typeInfo(T) == .int and T.is_signed and numerator == std.math.minInt(T) and denominator == -1){#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>{#syntax#}@divTrunc(-5, 3) == -1{#endsyntax#}</li>
langref: fix equations
2020-10-19 02:43:34 +00:00
<li>{#syntax#}(@divTrunc(a, b) * b) + @rem(a, b) == a{#endsyntax#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>For a function that returns a possible error code, use {#syntax#}@import("std").math.divTrunc{#endsyntax#}.</p>
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|@divFloor|@divExact#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@embedFile#}
embedFile: change notation from [X:0] to [N:0] This is for consistency with the documentation on sentinel-terminated {arrays,slices,pointers} which already use `N` for a comptime-inferred size rather than `X`. Also adds a behavioral test to assert that a string literal is returned.
2021-04-28 00:26:03 +00:00
<pre>{#syntax#}@embedFile(comptime path: []const u8) *const [N:0]u8{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
fix `@embedFile` docs
2020-03-06 21:01:26 +00:00
This function returns a compile time constant pointer to null-terminated,
fixed-size array with length equal to the byte count of the file given by
{#syntax#}path{#endsyntax#}. The contents of the array are the contents of the file.
Avoid concept of a "Unicode character" in documentation and error messages (#8059)
2021-02-24 13:26:13 +00:00
This is equivalent to a {#link|string literal|String Literals and Unicode Code Point Literals#}
fix `@embedFile` docs
2020-03-06 21:01:26 +00:00
with the file contents.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}path{#endsyntax#} is absolute or relative to the current file, just like {#syntax#}@import{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|@import#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
remove error set casting syntax. add `@errSetCast` See #1061
2018-06-18 19:01:42 +00:00
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
{#header_open|@enumFromInt#}
<pre>{#syntax#}@enumFromInt(integer: anytype) anytype{#endsyntax#}</pre>
remove enum to/from int casting syntax; add `@enumToInt`/`@intToEnum` see #1061
2018-06-19 07:50:38 +00:00
<p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
Converts an integer into an {#link|enum#} value. The return type is the inferred result type.
remove enum to/from int casting syntax; add `@enumToInt`/`@intToEnum` see #1061
2018-06-19 07:50:38 +00:00
</p>
fix tagged union with only 1 field tripping assertion closes #1495 now the tag type of an enum with only 1 item is comptime_int.
2018-09-13 17:29:43 +00:00
<p>
Remove old deprecated symbols in std (#21584) Also, actually run tests inside std/tar/writer.zig
2024-10-04 20:50:25 +00:00
Attempting to convert an integer with no corresponding value in the enum invokes
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
safety-checked {#link|Undefined Behavior#}.
improve `@enumFromInt` doc (#20354) closes #19123
2024-07-21 09:41:43 +00:00
Note that a {#link|non-exhaustive enum|Non-exhaustive enum#} has corresponding values for all
Remove old deprecated symbols in std (#21584) Also, actually run tests inside std/tar/writer.zig
2024-10-04 20:50:25 +00:00
integers in the enum's integer tag type: the {#syntax#}_{#endsyntax#} value represents all
improve `@enumFromInt` doc (#20354) closes #19123
2024-07-21 09:41:43 +00:00
the remaining unnamed integers in the enum's tag type.
fix tagged union with only 1 field tripping assertion closes #1495 now the tag type of an enum with only 1 item is comptime_int.
2018-09-13 17:29:43 +00:00
</p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
{#see_also|@intFromEnum#}
{#header_close#}
{#header_open|@errorFromInt#}
remove uses of non-configurable `err_int`
2023-10-21 09:56:05 +00:00
<pre>{#syntax#}@errorFromInt(value: std.meta.Int(.unsigned, @bitSizeOf(anyerror))) anyerror{#endsyntax#}</pre>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
<p>
Converts from the integer representation of an error into {#link|The Global Error Set#} type.
</p>
<p>
It is generally recommended to avoid this
cast, as the integer representation of an error is not stable across source code changes.
</p>
<p>
Attempting to convert an integer that does not correspond to any error results in
safety-protected {#link|Undefined Behavior#}.
</p>
{#see_also|@intFromError#}
remove enum to/from int casting syntax; add `@enumToInt`/`@intToEnum` see #1061
2018-06-19 07:50:38 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@errorName#}
errorName: return a null-terminated slice
2021-04-28 00:00:32 +00:00
<pre>{#syntax#}@errorName(err: anyerror) [:0]const u8{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: fix some incorrect error documentation
2018-11-19 18:20:39 +00:00
This function returns the string representation of an error. The string representation
of {#syntax#}error.OutOfMem{#endsyntax#} is {#syntax#}"OutOfMem"{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
If there are no calls to {#syntax#}@errorName{#endsyntax#} in an entire application,
docs: fix some incorrect error documentation
2018-11-19 18:20:39 +00:00
or all calls have a compile-time known value for {#syntax#}err{#endsyntax#}, then no
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
error name table will be generated.
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
remove error to/from int casting syntax; add `@errorToInt`/`@intToError` See #1061
2018-06-18 22:48:29 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@errorReturnTrace#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}@errorReturnTrace() ?*builtin.StackTrace{#endsyntax#}</pre>
clean up error return tracing * error return tracing is disabled in release-fast mode * add @errorReturnTrace * zig build API changes build return type from `void` to `%void` * allow `void`, `noreturn`, and `u8` from main. closes #535
2018-01-15 05:01:02 +00:00
<p>
If the binary is built with error return tracing, and this function is invoked in a
function that calls a function with an error or error union return type, returns a
Fix backticked code in langref
2020-11-03 17:37:28 +00:00
stack trace object. Otherwise returns {#link|null#}.
clean up error return tracing * error return tracing is disabled in release-fast mode * add @errorReturnTrace * zig build API changes build return type from `void` to `%void` * allow `void`, `noreturn`, and `u8` from main. closes #535
2018-01-15 05:01:02 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
remove error set casting syntax. add `@errSetCast` See #1061
2018-06-18 19:01:42 +00:00
Sema: add `@errorCast` which works for both error sets and error unions Closes #17343
2023-10-01 10:16:02 +00:00
{#header_open|@errorCast#}
<pre>{#syntax#}@errorCast(value: anytype) anytype{#endsyntax#}</pre>
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
<p>
Sema: add `@errorCast` which works for both error sets and error unions Closes #17343
2023-10-01 10:16:02 +00:00
Converts an error set or error union value from one error set to another error set. The return type is the
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
inferred result type. Attempting to convert an error which is not in the destination error
set results in safety-protected {#link|Undefined Behavior#}.
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
</p>
{#header_close#}
remove error set casting syntax. add `@errSetCast` See #1061
2018-06-18 19:01:42 +00:00
{#header_open|@export#}
lib,test,tools,doc: update usages of @export
2024-08-26 02:49:36 +00:00
<pre>{#syntax#}@export(comptime ptr: *const anyopaque, comptime options: std.builtin.ExportOptions) void{#endsyntax#}</pre>
<p>Creates a symbol in the output object file which refers to the target of <code>ptr</code>.</p>
<p><code>ptr</code> must point to a global variable or a comptime-known constant.</p>
AstGen: support `@export` with field access The Zig language specification will support identifiers and field access in order to refer to which declaration to export with `@export`. This commit implements the change in AstGen and updates the language reference.
2021-06-15 21:08:57 +00:00
<p>
This builtin can be called from a {#link|comptime#} block to conditionally export symbols.
lib,test,tools,doc: update usages of @export
2024-08-26 02:49:36 +00:00
When <code>ptr</code> points to a function with the C calling convention and
{#syntax#}options.linkage{#endsyntax#} is {#syntax#}.Strong{#endsyntax#}, this is equivalent to
add documentation for @"" syntax closes #1614
2019-03-13 15:54:56 +00:00
the {#syntax#}export{#endsyntax#} keyword used on a function:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|export_builtin.zig#}
add documentation for @"" syntax closes #1614
2019-03-13 15:54:56 +00:00
<p>This is equivalent to:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|export_builtin_equivalent_code.zig#}
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
<p>Note that even when using {#syntax#}export{#endsyntax#}, the {#syntax#}@"foo"{#endsyntax#} syntax for
{#link|identifiers|Identifiers#} can be used to choose any string for the symbol name:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|export_any_symbol_name.zig#}
add documentation for @"" syntax closes #1614
2019-03-13 15:54:56 +00:00
<p>
When looking at the resulting object, you can see the symbol is used verbatim:
</p>
Add meta viewport to fix mobile rendering, add missing <code> block Co-authored-by: Vexu <git@vexu.eu>
2020-07-27 14:10:55 +00:00
<pre><code>00000000000001f0 T A function name that is a complete sentence.</code></pre>
add documentation for @"" syntax closes #1614
2019-03-13 15:54:56 +00:00
{#see_also|Exporting a C Library#}
remove error set casting syntax. add `@errSetCast` See #1061
2018-06-18 19:01:42 +00:00
{#header_close#}
langref: add docs for `@extern`
2021-04-22 23:24:14 +00:00
{#header_open|@extern#}
langref: fix documentation for @extern
2023-07-08 13:11:58 +00:00
<pre>{#syntax#}@extern(T: type, comptime options: std.builtin.ExternOptions) T{#endsyntax#}</pre>
langref: add docs for `@extern`
2021-04-22 23:24:14 +00:00
<p>
Creates a reference to an external symbol in the output object file.
langref: fix documentation for @extern
2023-07-08 13:11:58 +00:00
T must be a pointer type.
langref: add docs for `@extern`
2021-04-22 23:24:14 +00:00
</p>
{#see_also|@export#}
{#header_close#}
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
{#header_open|@field#}
add 'anytype' to stage1 and langref
2020-07-11 11:08:20 +00:00
<pre>{#syntax#}@field(lhs: anytype, comptime field_name: []const u8) (field){#endsyntax#}</pre>
docs: Clarify that @field can work on declarations
2021-02-01 17:11:06 +00:00
<p>Performs field access by a compile-time string. Works on both fields and declarations.
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_field_builtin.zig#}
Shorten @field documentation and add an example
2019-09-04 17:02:31 +00:00
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@fieldParentPtr#}
Update uses of `@fieldParentPtr` to use RLS
2024-03-19 11:46:38 +00:00
<pre>{#syntax#}@fieldParentPtr(comptime field_name: []const u8, field_ptr: *T) anytype{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Given a pointer to a field, returns the base pointer of a struct.
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
compiler: implement `@FieldType` Resolves: #21702
2024-10-17 09:19:14 +00:00
{#header_open|@FieldType#}
<pre>{#syntax#}@FieldType(comptime Type: type, comptime field_name: []const u8) type{#endsyntax#}</pre>
<p>
Given a type and the name of one of its fields, returns the type of that field.
</p>
{#header_close#}
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
{#header_open|@floatCast#}
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
<pre>{#syntax#}@floatCast(value: anytype) anytype{#endsyntax#}</pre>
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
<p>
Convert from one float type to another. This cast is safe, but may cause the
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
numeric value to lose precision. The return type is the inferred result type.
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
</p>
{#header_close#}
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
{#header_open|@floatFromInt#}
<pre>{#syntax#}@floatFromInt(int: anytype) anytype{#endsyntax#}</pre>
`@floatToInt` now has safety-checked undefined behavior when the integer part does not fit in the destination integer type * Also fix incorrect safety triggered for integer casting an `i32` to a `u7`. closes #1138 * adds compiler-rt function: `__floatuntidf`
2018-06-19 20:06:10 +00:00
<p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
Converts an integer to the closest floating point representation. The return type is the inferred result type.
langref: avoid the ambiguous word "safe" See #2402
2024-01-19 03:58:35 +00:00
To convert the other way, use {#link|@intFromFloat#}. This operation is legal
for all values of all integer types.
`@floatToInt` now has safety-checked undefined behavior when the integer part does not fit in the destination integer type * Also fix incorrect safety triggered for integer casting an `i32` to a `u7`. closes #1138 * adds compiler-rt function: `__floatuntidf`
2018-06-19 20:06:10 +00:00
</p>
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@frameAddress#}
@returnAddress and @frameAddress return usize now
2019-03-02 20:34:58 +00:00
<pre>{#syntax#}@frameAddress() usize{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
This function returns the base pointer of the current stack frame.
</p>
<p>
Fix minor langref typos
2022-09-24 18:42:00 +00:00
The implications of this are target-specific and not consistent across all
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
platforms. The frame address may not be available in release mode due to
aggressive optimizations.
</p>
<p>
This function is only valid within function scope.
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
introduce @hasDecl builtin function closes #1439
2019-05-26 20:21:03 +00:00
{#header_open|@hasDecl#}
docs: docgen supports release safe exe code examples and make the type names of `@hasDecl` and `@hasField` consistent
2019-09-29 21:28:30 +00:00
<pre>{#syntax#}@hasDecl(comptime Container: type, comptime name: []const u8) bool{#endsyntax#}</pre>
introduce @hasDecl builtin function closes #1439
2019-05-26 20:21:03 +00:00
<p>
langref: add appendix and explain 'container' terminology
2022-11-09 08:29:50 +00:00
Returns whether or not a {#link|container|Containers#} has a declaration
introduce @hasDecl builtin function closes #1439
2019-05-26 20:21:03 +00:00
matching {#syntax#}name{#endsyntax#}.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_hasDecl_builtin.zig#}
introduce @hasDecl builtin function closes #1439
2019-05-26 20:21:03 +00:00
fixups
2019-07-02 20:52:55 +00:00
{#see_also|@hasField#}
{#header_close#}
{#header_open|@hasField#}
docs: docgen supports release safe exe code examples and make the type names of `@hasDecl` and `@hasField` consistent
2019-09-29 21:28:30 +00:00
<pre>{#syntax#}@hasField(comptime Container: type, comptime name: []const u8) bool{#endsyntax#}</pre>
fixups
2019-07-02 20:52:55 +00:00
<p>Returns whether the field name of a struct, union, or enum exists.</p>
<p>
The result is a compile time constant.
</p>
<p>
It does not include functions, variables, or constants.
</p>
{#see_also|@hasDecl#}
introduce @hasDecl builtin function closes #1439
2019-05-26 20:21:03 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@import#}
langref builtin parameters: []u8 -> []const u8 None of these builtins modify the passed string. This parameter type can be misleading.
2023-07-21 21:03:26 +00:00
<pre>{#syntax#}@import(comptime path: []const u8) type{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
add documentation for `pub` closes #1727
2019-03-13 17:04:55 +00:00
This function finds a zig file corresponding to {#syntax#}path{#endsyntax#} and adds it to the build,
if it is not already added.
</p>
<p>
Zig source files are implicitly structs, with a name equal to the file's basename with the extension
truncated. {#syntax#}@import{#endsyntax#} returns the struct type corresponding to the file.
</p>
<p>
Declarations which have the {#syntax#}pub{#endsyntax#} keyword may be referenced from a different
source file than the one they are declared in.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
in docs removed "path can be absolute" for imports
2020-07-01 19:44:18 +00:00
{#syntax#}path{#endsyntax#} can be a relative path or it can be the name of a package.
add documentation for `pub` closes #1727
2019-03-13 17:04:55 +00:00
If it is a relative path, it is relative to the file that contains the {#syntax#}@import{#endsyntax#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
function call.
</p>
<p>
The following packages are always available:
</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>{#syntax#}@import("std"){#endsyntax#} - Zig Standard Library</li>
Improvements to docs and text * docs(std.math): elaborate on difference between absCast and absInt * docs(std.rand.Random.weightedIndex): elaborate on likelihood I think this makes it easier to understand. * langref: add small reminder * docs(std.fs.path.extension): brevity * docs(std.bit_set.StaticBitSet): mention the specific types * std.debug.TTY: explain what purpose this struct serves This should also make it clearer that this struct is not supposed to provide unrelated terminal manipulation functionality such as setting the cursor position or something because terminals are complicated and we should keep this struct simple and focused on debugging. * langref(package listing): brevity * langref: explain what exactly `threadlocal` causes to happen * std.array_list: link between swapRemove and orderedRemove Maybe this can serve as a TLDR and make it easier to decide. * PrefetchOptions.locality: clarify docs that this is a range This confused me previously and I thought I can only use either 0 or 3. * fix typos and more * std.builtin.CallingConvention: document some CCs * langref: explain possibly cryptic names I think it helps knowing what exactly these acronyms (@clz and @ctz) and abbreviations (@popCount) mean. * variadic function error: add missing preposition * std.fmt.format docs: nicely hyphenate * help menu: say what to optimize for I think this is slightly more specific than just calling it "optimizations". These are speed optimizations. I used the word "performance" here.
2023-04-23 18:06:21 +00:00
<li>{#syntax#}@import("builtin"){#endsyntax#} - Target-specific information
update langref, compile-error tests, safety tests for the std.builtin re-arranging
2021-05-17 22:25:27 +00:00
The command <code>zig build-exe --show-builtin</code> outputs the source to stdout for reference.
add documentation for `pub` closes #1727
2019-03-13 17:04:55 +00:00
</li>
Improvements to docs and text * docs(std.math): elaborate on difference between absCast and absInt * docs(std.rand.Random.weightedIndex): elaborate on likelihood I think this makes it easier to understand. * langref: add small reminder * docs(std.fs.path.extension): brevity * docs(std.bit_set.StaticBitSet): mention the specific types * std.debug.TTY: explain what purpose this struct serves This should also make it clearer that this struct is not supposed to provide unrelated terminal manipulation functionality such as setting the cursor position or something because terminals are complicated and we should keep this struct simple and focused on debugging. * langref(package listing): brevity * langref: explain what exactly `threadlocal` causes to happen * std.array_list: link between swapRemove and orderedRemove Maybe this can serve as a TLDR and make it easier to decide. * PrefetchOptions.locality: clarify docs that this is a range This confused me previously and I thought I can only use either 0 or 3. * fix typos and more * std.builtin.CallingConvention: document some CCs * langref: explain possibly cryptic names I think it helps knowing what exactly these acronyms (@clz and @ctz) and abbreviations (@popCount) mean. * variadic function error: add missing preposition * std.fmt.format docs: nicely hyphenate * help menu: say what to optimize for I think this is slightly more specific than just calling it "optimizations". These are speed optimizations. I used the word "performance" here.
2023-04-23 18:06:21 +00:00
<li>{#syntax#}@import("root"){#endsyntax#} - Root source file
This is usually <code>src/main.zig</code> but depends on what file is built.
Add missing package to the langref that's always available
2022-01-07 18:50:21 +00:00
</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|Compile Variables|@embedFile#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
Add `@inComptime` builtin Resolves: #868
2023-04-14 21:32:31 +00:00
{#header_open|@inComptime#}
<pre>{#syntax#}@inComptime() bool{#endsyntax#}</pre>
<p>
Returns whether the builtin was run in a {#syntax#}comptime{#endsyntax#} context. The result is a compile-time constant.
</p>
<p>
This can be used to provide alternative, comptime-friendly implementations of functions. It should not be used, for instance, to exclude certain functions from being evaluated at comptime.
</p>
{#see_also|comptime#}
{#header_close#}
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
{#header_open|@intCast#}
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
<pre>{#syntax#}@intCast(int: anytype) anytype{#endsyntax#}</pre>
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
<p>
Converts an integer to another integer while keeping the same numerical value.
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
The return type is the inferred result type.
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
Attempting to convert a number which is out of range of the destination type results in
remove error to/from int casting syntax; add `@errorToInt`/`@intToError` See #1061
2018-06-18 22:48:29 +00:00
safety-protected {#link|Undefined Behavior#}.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_intCast_builtin.zig#}
docs: reorganize `@truncate` and `@intCast` for clarity
2021-11-28 11:28:47 +00:00
<p>
To truncate the significant bits of a number out of range of the destination type, use {#link|@truncate#}.
</p>
docs: this statement was in the wrong section
2019-11-29 17:41:07 +00:00
<p>
If {#syntax#}T{#endsyntax#} is {#syntax#}comptime_int{#endsyntax#},
then this is semantically equivalent to {#link|Type Coercion#}.
</p>
remove error to/from int casting syntax; add `@errorToInt`/`@intToError` See #1061
2018-06-18 22:48:29 +00:00
{#header_close#}
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
{#header_open|@intFromBool#}
<pre>{#syntax#}@intFromBool(value: bool) u1{#endsyntax#}</pre>
remove enum to/from int casting syntax; add `@enumToInt`/`@intToEnum` see #1061
2018-06-19 07:50:38 +00:00
<p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
Converts {#syntax#}true{#endsyntax#} to {#syntax#}@as(u1, 1){#endsyntax#} and {#syntax#}false{#endsyntax#} to
{#syntax#}@as(u1, 0){#endsyntax#}.
remove enum to/from int casting syntax; add `@enumToInt`/`@intToEnum` see #1061
2018-06-19 07:50:38 +00:00
</p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
{#header_close#}
{#header_open|@intFromEnum#}
<pre>{#syntax#}@intFromEnum(enum_or_tagged_union: anytype) anytype{#endsyntax#}</pre>
remove enum to/from int casting syntax; add `@enumToInt`/`@intToEnum` see #1061
2018-06-19 07:50:38 +00:00
<p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
Converts an enumeration value into its integer tag type. When a tagged union is passed,
the tag value is used as the enumeration value.
remove enum to/from int casting syntax; add `@enumToInt`/`@intToEnum` see #1061
2018-06-19 07:50:38 +00:00
</p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
<p>
If there is only one possible enum value, the result is a {#syntax#}comptime_int{#endsyntax#}
known at {#link|comptime#}.
</p>
{#see_also|@enumFromInt#}
remove enum to/from int casting syntax; add `@enumToInt`/`@intToEnum` see #1061
2018-06-19 07:50:38 +00:00
{#header_close#}
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
{#header_open|@intFromError#}
remove uses of non-configurable `err_int`
2023-10-21 09:56:05 +00:00
<pre>{#syntax#}@intFromError(err: anytype) std.meta.Int(.unsigned, @bitSizeOf(anyerror)){#endsyntax#}</pre>
remove error to/from int casting syntax; add `@errorToInt`/`@intToError` See #1061
2018-06-18 22:48:29 +00:00
<p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
Supports the following types:
remove error to/from int casting syntax; add `@errorToInt`/`@intToError` See #1061
2018-06-18 22:48:29 +00:00
</p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
<ul>
<li>{#link|The Global Error Set#}</li>
<li>{#link|Error Set Type#}</li>
<li>{#link|Error Union Type#}</li>
</ul>
remove error to/from int casting syntax; add `@errorToInt`/`@intToError` See #1061
2018-06-18 22:48:29 +00:00
<p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
Converts an error to the integer representation of an error.
remove error to/from int casting syntax; add `@errorToInt`/`@intToError` See #1061
2018-06-18 22:48:29 +00:00
</p>
<p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
It is generally recommended to avoid this
cast, as the integer representation of an error is not stable across source code changes.
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
</p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
{#see_also|@errorFromInt#}
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
{#header_close#}
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
{#header_open|@intFromFloat#}
<pre>{#syntax#}@intFromFloat(float: anytype) anytype{#endsyntax#}</pre>
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
<p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
Converts the integer part of a floating point number to the inferred result type.
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
</p>
implement allowzero pointer attribute closes #1953 only needed for freestanding targets. also adds safety for `@intToPtr` when the address is zero.
2019-03-25 16:55:45 +00:00
<p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
If the integer part of the floating point number cannot fit in the destination type,
it invokes safety-checked {#link|Undefined Behavior#}.
implement allowzero pointer attribute closes #1953 only needed for freestanding targets. also adds safety for `@intToPtr` when the address is zero.
2019-03-25 16:55:45 +00:00
</p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
{#see_also|@floatFromInt#}
{#header_close#}
{#header_open|@intFromPtr#}
<pre>{#syntax#}@intFromPtr(value: anytype) usize{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
Converts {#syntax#}value{#endsyntax#} to a {#syntax#}usize{#endsyntax#} which is the address of the pointer.
{#syntax#}value{#endsyntax#} can be {#syntax#}*T{#endsyntax#} or {#syntax#}?*T{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
<p>To convert the other way, use {#link|@ptrFromInt#}</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
all: rename `@maximum` to `@max` and `@minimum` to `@min`
2022-10-03 16:34:30 +00:00
{#header_open|@max#}
langref: update builtin variadic functions Documentation was outdated.
2024-10-03 11:37:36 +00:00
<pre>{#syntax#}@max(...) T{#endsyntax#}</pre>
minimum/maximum builtins
2021-07-25 03:34:11 +00:00
<p>
langref: update builtin variadic functions Documentation was outdated.
2024-10-03 11:37:36 +00:00
Takes two or more arguments and returns the biggest value included (the maximum). This builtin accepts integers, floats, and vectors of either. In the latter case, the operation is performed element wise.
minimum/maximum builtins
2021-07-25 03:34:11 +00:00
</p>
<p>
langref: update builtin variadic functions Documentation was outdated.
2024-10-03 11:37:36 +00:00
NaNs are handled as follows: return the biggest non-NaN value included. If all operands are NaN, return NaN.
minimum/maximum builtins
2021-07-25 03:34:11 +00:00
</p>
all: rename `@maximum` to `@max` and `@minimum` to `@min`
2022-10-03 16:34:30 +00:00
{#see_also|@min|Vectors#}
minimum/maximum builtins
2021-07-25 03:34:11 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@memcpy#}
change semantics of `@memcpy` and `@memset` Now they use slices or array pointers with any element type instead of requiring byte pointers. This is a breaking enhancement to the language. The safety check for overlapping pointers will be implemented in a future commit. closes #14040
2023-04-14 04:44:40 +00:00
<pre>{#syntax#}@memcpy(noalias dest, noalias source) void{#endsyntax#}</pre>
<p>This function copies bytes from one region of memory to another.</p>
update `@memcpy` to require equal src and dest lens * Sema: upgrade operands to array pointers if possible when emitting AIR. * Implement safety checks for length mismatch and aliasing. * AIR: make ptrtoint support slice operands. Implement in LLVM backend. * C backend: implement new `@memset` semantics. `@memcpy` is not done yet.
2023-04-22 01:03:33 +00:00
<p>{#syntax#}dest{#endsyntax#} must be a mutable slice, a mutable pointer to an array, or
langref: fix compile error
2023-04-24 19:56:24 +00:00
a mutable many-item {#link|pointer|Pointers#}. It may have any
update `@memcpy` to require equal src and dest lens * Sema: upgrade operands to array pointers if possible when emitting AIR. * Implement safety checks for length mismatch and aliasing. * AIR: make ptrtoint support slice operands. Implement in LLVM backend. * C backend: implement new `@memset` semantics. `@memcpy` is not done yet.
2023-04-22 01:03:33 +00:00
alignment, and it may have any element type.</p>
Remove incorrect statements that the `source` argument to @memcpy needs to be mutable
2023-05-13 22:02:41 +00:00
<p>{#syntax#}source{#endsyntax#} must be a slice, a pointer to
an array, or a many-item {#link|pointer|Pointers#}. It may
have any alignment, and it may have any element type.</p>
update `@memcpy` to require equal src and dest lens * Sema: upgrade operands to array pointers if possible when emitting AIR. * Implement safety checks for length mismatch and aliasing. * AIR: make ptrtoint support slice operands. Implement in LLVM backend. * C backend: implement new `@memset` semantics. `@memcpy` is not done yet.
2023-04-22 01:03:33 +00:00
<p>The {#syntax#}source{#endsyntax#} element type must support {#link|Type Coercion#}
into the {#syntax#}dest{#endsyntax#} element type. The element types may have
different ABI size, however, that may incur a performance penalty.</p>
<p>Similar to {#link|for#} loops, at least one of {#syntax#}source{#endsyntax#} and
{#syntax#}dest{#endsyntax#} must provide a length, and if two lengths are provided,
they must be equal.</p>
<p>Finally, the two memory regions must not overlap.</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@memset#}
change semantics of `@memcpy` and `@memset` Now they use slices or array pointers with any element type instead of requiring byte pointers. This is a breaking enhancement to the language. The safety check for overlapping pointers will be implemented in a future commit. closes #14040
2023-04-14 04:44:40 +00:00
<pre>{#syntax#}@memset(dest, elem) void{#endsyntax#}</pre>
<p>This function sets all the elements of a memory region to {#syntax#}elem{#endsyntax#}.</p>
<p>{#syntax#}dest{#endsyntax#} must be a mutable slice or a mutable pointer to an array.
It may have any alignment, and it may have any element type.</p>
<p>{#syntax#}elem{#endsyntax#} is coerced to the element type of {#syntax#}dest{#endsyntax#}.</p>
Small documentation fixes on `std.crypto` (#16427) * Small documentation fix of ChaCha variants Previous documentation was seemingly copy-pasted and left behind some errors where the number of rounds was not properly updated. * Suggest `std.crypto.utils.secureZero` on `@memset` docs * Revert previous change
2023-07-17 21:16:41 +00:00
<p>For securely zeroing out sensitive contents from memory, you should use
std.crypto: better names for everything in utils std.crypto has quite a few instances of breaking naming conventions. This is the beginning of an effort to address that. Deprecates `std.crypto.utils`.
2024-08-09 21:04:02 +00:00
{#syntax#}std.crypto.secureZero{#endsyntax#}</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
all: rename `@maximum` to `@max` and `@minimum` to `@min`
2022-10-03 16:34:30 +00:00
{#header_open|@min#}
langref: update builtin variadic functions Documentation was outdated.
2024-10-03 11:37:36 +00:00
<pre>{#syntax#}@min(...) T{#endsyntax#}</pre>
minimum/maximum builtins
2021-07-25 03:34:11 +00:00
<p>
langref: update builtin variadic functions Documentation was outdated.
2024-10-03 11:37:36 +00:00
Takes two or more arguments and returns the smallest value included (the minimum). This builtin accepts integers, floats, and vectors of either. In the latter case, the operation is performed element wise.
minimum/maximum builtins
2021-07-25 03:34:11 +00:00
</p>
<p>
langref: update builtin variadic functions Documentation was outdated.
2024-10-03 11:37:36 +00:00
NaNs are handled as follows: return the smallest non-NaN value included. If all operands are NaN, return NaN.
minimum/maximum builtins
2021-07-25 03:34:11 +00:00
</p>
all: rename `@maximum` to `@max` and `@minimum` to `@min`
2022-10-03 16:34:30 +00:00
{#see_also|@max|Vectors#}
minimum/maximum builtins
2021-07-25 03:34:11 +00:00
{#header_close#}
Document the builtins
2020-06-05 07:27:52 +00:00
{#header_open|@wasmMemorySize#}
llvm: fix `@wasmMemory{Size,Grow}` for wasm64 Closes #19942
2024-05-20 11:38:59 +00:00
<pre>{#syntax#}@wasmMemorySize(index: u32) usize{#endsyntax#}</pre>
Document the builtins
2020-06-05 07:27:52 +00:00
<p>
This function returns the size of the Wasm memory identified by {#syntax#}index{#endsyntax#} as
an unsigned value in units of Wasm pages. Note that each Wasm page is 64KB in size.
</p>
<p>
This function is a low level intrinsic with no safety mechanisms usually useful for allocator
designers targeting Wasm. So unless you are writing a new allocator from scratch, you should use
Update langref.html.in
2020-06-05 08:16:41 +00:00
something like {#syntax#}@import("std").heap.WasmPageAllocator{#endsyntax#}.
Document the builtins
2020-06-05 07:27:52 +00:00
</p>
{#see_also|@wasmMemoryGrow#}
{#header_close#}
{#header_open|@wasmMemoryGrow#}
llvm: fix `@wasmMemory{Size,Grow}` for wasm64 Closes #19942
2024-05-20 11:38:59 +00:00
<pre>{#syntax#}@wasmMemoryGrow(index: u32, delta: usize) isize{#endsyntax#}</pre>
Document the builtins
2020-06-05 07:27:52 +00:00
<p>
This function increases the size of the Wasm memory identified by {#syntax#}index{#endsyntax#} by
{#syntax#}delta{#endsyntax#} in units of unsigned number of Wasm pages. Note that each Wasm page
is 64KB in size. On success, returns previous memory size; on failure, if the allocation fails,
returns -1.
</p>
<p>
This function is a low level intrinsic with no safety mechanisms usually useful for allocator
designers targeting Wasm. So unless you are writing a new allocator from scratch, you should use
Update langref.html.in
2020-06-05 08:16:41 +00:00
something like {#syntax#}@import("std").heap.WasmPageAllocator{#endsyntax#}.
Document the builtins
2020-06-05 07:27:52 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_wasmMemoryGrow_builtin.zig#}
Document the builtins
2020-06-05 07:27:52 +00:00
{#see_also|@wasmMemorySize#}
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@mod#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}@mod(numerator: T, denominator: T) T{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Modulus division. For unsigned integers this is the same as
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
{#syntax#}numerator % denominator{#endsyntax#}. Caller guarantees {#syntax#}denominator > 0{#endsyntax#}, otherwise the
operation will result in a {#link|Remainder Division by Zero#} when runtime safety checks are enabled.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>{#syntax#}@mod(-5, 3) == 1{#endsyntax#}</li>
langref: fix equations
2020-10-19 02:43:34 +00:00
<li>{#syntax#}(@divFloor(a, b) * b) + @mod(a, b) == a{#endsyntax#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>For a function that returns an error code, see {#syntax#}@import("std").math.mod{#endsyntax#}.</p>
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|@rem#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@mulWithOverflow#}
update uses of overflow arithmetic builtins
2022-12-21 14:40:30 +00:00
<pre>{#syntax#}@mulWithOverflow(a: anytype, b: anytype) struct { @TypeOf(a, b), u1 }{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
update uses of overflow arithmetic builtins
2022-12-21 14:40:30 +00:00
Performs {#syntax#}a * b{#endsyntax#} and returns a tuple with the result and a possible overflow bit.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@panic#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}@panic(message: []const u8) noreturn{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Invokes the panic handler function. By default the panic handler function
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
calls the public {#syntax#}panic{#endsyntax#} function exposed in the root source file, or
Update documentation of @panic The default panic handler implementation was moved to `builtin.zig`.
2020-04-12 09:41:00 +00:00
if there is not one specified, the {#syntax#}std.builtin.default_panic{#endsyntax#}
function from {#syntax#}std/builtin.zig{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>Generally it is better to use {#syntax#}@import("std").debug.panic{#endsyntax#}.
However, {#syntax#}@panic{#endsyntax#} can be useful for 2 scenarios:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<ul>
<li>From library code, calling the programmer's panic function if they exposed one in the root source file.</li>
<li>When mixing C and Zig code, calling the canonical panic implementation across multiple .o files.</li>
</ul>
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|Root Source File#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
add @popCount intrinsic
2018-07-07 04:25:32 +00:00
{#header_open|@popCount#}
langref: add missing return types to builtin functions This should add all remaining missing return types to all builtin functions. For @clz, @ctz, and @popCount it uses anytype for the lack of a better alternative. We already use this return type for other builtin functions in the langref to indicate that the type is not always the same. It is not possible to use anytype as the return type for regular functions but builtin functions are special.
2023-03-03 15:16:08 +00:00
<pre>{#syntax#}@popCount(operand: anytype) anytype{#endsyntax#}</pre>
stage2+stage1: remove type parameter from bit builtins Closes #12529 Closes #12511 Closes #6835
2022-08-21 14:24:04 +00:00
<p>{#syntax#}@TypeOf(operand){#endsyntax#} must be an integer type.</p>
Add vector support for @popCount
2021-07-26 00:35:55 +00:00
<p>{#syntax#}operand{#endsyntax#} may be an {#link|integer|Integers#} or {#link|vector|Vectors#}.</p>
Improvements to docs and text * docs(std.math): elaborate on difference between absCast and absInt * docs(std.rand.Random.weightedIndex): elaborate on likelihood I think this makes it easier to understand. * langref: add small reminder * docs(std.fs.path.extension): brevity * docs(std.bit_set.StaticBitSet): mention the specific types * std.debug.TTY: explain what purpose this struct serves This should also make it clearer that this struct is not supposed to provide unrelated terminal manipulation functionality such as setting the cursor position or something because terminals are complicated and we should keep this struct simple and focused on debugging. * langref(package listing): brevity * langref: explain what exactly `threadlocal` causes to happen * std.array_list: link between swapRemove and orderedRemove Maybe this can serve as a TLDR and make it easier to decide. * PrefetchOptions.locality: clarify docs that this is a range This confused me previously and I thought I can only use either 0 or 3. * fix typos and more * std.builtin.CallingConvention: document some CCs * langref: explain possibly cryptic names I think it helps knowing what exactly these acronyms (@clz and @ctz) and abbreviations (@popCount) mean. * variadic function error: add missing preposition * std.fmt.format docs: nicely hyphenate * help menu: say what to optimize for I think this is slightly more specific than just calling it "optimizations". These are speed optimizations. I used the word "performance" here.
2023-04-23 18:06:21 +00:00
<p>
Counts the number of bits set in an integer - "population count".
</p>
add @popCount intrinsic
2018-07-07 04:25:32 +00:00
<p>
Add vector support for @popCount
2021-07-26 00:35:55 +00:00
If {#syntax#}operand{#endsyntax#} is a {#link|comptime#}-known integer,
fixups to the previous commit
2019-05-16 20:32:24 +00:00
the return type is {#syntax#}comptime_int{#endsyntax#}.
Add vector support for @popCount
2021-07-26 00:35:55 +00:00
Otherwise, the return type is an unsigned integer or vector of unsigned integers with the minimum number
add @popCount intrinsic
2018-07-07 04:25:32 +00:00
of bits that can represent the bit count of the integer type.
</p>
{#see_also|@ctz|@clz#}
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
langref: document @prefetch() builtin
2021-12-10 22:06:08 +00:00
{#header_open|@prefetch#}
langref: make more consistent * moves some langref into std.builtin doc comments * use the same way of referencing stuff from std.builtin closes #16483
2024-01-22 03:39:50 +00:00
<pre>{#syntax#}@prefetch(ptr: anytype, comptime options: PrefetchOptions) void{#endsyntax#}</pre>
langref: document @prefetch() builtin
2021-12-10 22:06:08 +00:00
<p>
This builtin tells the compiler to emit a prefetch instruction if supported by the
target CPU. If the target CPU does not support the requested prefetch instruction,
Fix minor langref typos
2022-09-24 18:42:00 +00:00
this builtin is a no-op. This function has no effect on the behavior of the program,
langref: document @prefetch() builtin
2021-12-10 22:06:08 +00:00
only on the performance characteristics.
</p>
<p>
The {#syntax#}ptr{#endsyntax#} argument may be any pointer type and determines the memory
address to prefetch. This function does not dereference the pointer, it is perfectly legal
to pass a pointer to invalid memory to this function and no illegal behavior will result.
</p>
langref: make more consistent * moves some langref into std.builtin doc comments * use the same way of referencing stuff from std.builtin closes #16483
2024-01-22 03:39:50 +00:00
<p>{#syntax#}PrefetchOptions{#endsyntax#} can be found with {#syntax#}@import("std").builtin.PrefetchOptions{#endsyntax#}.</p>
langref: document @prefetch() builtin
2021-12-10 22:06:08 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@ptrCast#}
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
<pre>{#syntax#}@ptrCast(value: anytype) anytype{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
Converts a pointer of one type to a pointer of another type. The return type is the inferred result type.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
add docs for C pointers
2019-02-14 23:59:20 +00:00
<p>
{#link|Optional Pointers#} are allowed. Casting an optional pointer which is {#link|null#}
to a non-optional pointer invokes safety-checked {#link|Undefined Behavior#}.
</p>
Sema: add helpful notes to invalid `@ptrCast` operations Closes #14474
2023-01-27 14:03:51 +00:00
<p>
{#syntax#}@ptrCast{#endsyntax#} cannot be used for:
</p>
<ul>
split `@qualCast` into `@constCast` and `@volatileCast`
2023-02-13 14:19:17 +00:00
<li>Removing {#syntax#}const{#endsyntax#} qualifier, use {#link|@constCast#}.</li>
<li>Removing {#syntax#}volatile{#endsyntax#} qualifier, use {#link|@volatileCast#}.</li>
implement `@qualCast`
2023-01-27 18:25:48 +00:00
<li>Changing pointer address space, use {#link|@addrSpaceCast#}.</li>
<li>Increasing pointer alignment, use {#link|@alignCast#}.</li>
<li>Casting a non-slice pointer to a slice, use slicing syntax {#syntax#}ptr[start..end]{#endsyntax#}.</li>
Sema: add helpful notes to invalid `@ptrCast` operations Closes #14474
2023-01-27 14:03:51 +00:00
</ul>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
{#header_open|@ptrFromInt#}
<pre>{#syntax#}@ptrFromInt(address: usize) anytype{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
langref: correct ordering of @xFromY builtins
2023-06-28 09:22:32 +00:00
Converts an integer to a {#link|pointer|Pointers#}. The return type is the inferred result type.
To convert the other way, use {#link|@intFromPtr#}. Casting an address of 0 to a destination type
which in not {#link|optional|Optional Pointers#} and does not have the {#syntax#}allowzero{#endsyntax#} attribute will result in a
{#link|Pointer Cast Invalid Null#} panic when runtime safety checks are enabled.
</p>
<p>
If the destination pointer type does not allow address zero and {#syntax#}address{#endsyntax#}
is zero, this invokes safety-checked {#link|Undefined Behavior#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@rem#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}@rem(numerator: T, denominator: T) T{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Remainder division. For unsigned integers this is the same as
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
{#syntax#}numerator % denominator{#endsyntax#}. Caller guarantees {#syntax#}denominator > 0{#endsyntax#}, otherwise the
operation will result in a {#link|Remainder Division by Zero#} when runtime safety checks are enabled.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>{#syntax#}@rem(-5, 3) == -2{#endsyntax#}</li>
langref: fix equations
2020-10-19 02:43:34 +00:00
<li>{#syntax#}(@divTrunc(a, b) * b) + @rem(a, b) == a{#endsyntax#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>For a function that returns an error code, see {#syntax#}@import("std").math.rem{#endsyntax#}.</p>
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|@mod#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@returnAddress#}
@returnAddress and @frameAddress return usize now
2019-03-02 20:34:58 +00:00
<pre>{#syntax#}@returnAddress() usize{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
@returnAddress and @frameAddress return usize now
2019-03-02 20:34:58 +00:00
This function returns the address of the next machine code instruction that will be executed
when the current function returns.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
Fix minor langref typos
2022-09-24 18:42:00 +00:00
The implications of this are target-specific and not consistent across
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
all platforms.
</p>
<p>
@returnAddress and @frameAddress return usize now
2019-03-02 20:34:58 +00:00
This function is only valid within function scope. If the function gets inlined into
a calling function, the returned address will apply to the calling function.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
Add @select @select( comptime T: type, pred: std.meta.Vector(len, bool), a: std.meta.Vector(len, T), b: std.meta.Vector(len, T) ) std.meta.Vector(len, T) Constructs a vector from a & b, based on the values in the predicate vector. For indices where the predicate value is true, the corresponding element from the a vector is selected, and otherwise from b.
2021-07-26 00:37:11 +00:00
{#header_open|@select#}
basic language features do not belong in std.meta
2022-03-14 05:21:16 +00:00
<pre>{#syntax#}@select(comptime T: type, pred: @Vector(len, bool), a: @Vector(len, T), b: @Vector(len, T)) @Vector(len, T){#endsyntax#}</pre>
Add @select @select( comptime T: type, pred: std.meta.Vector(len, bool), a: std.meta.Vector(len, T), b: std.meta.Vector(len, T) ) std.meta.Vector(len, T) Constructs a vector from a & b, based on the values in the predicate vector. For indices where the predicate value is true, the corresponding element from the a vector is selected, and otherwise from b.
2021-07-26 00:37:11 +00:00
<p>
Selects values element-wise from {#syntax#}a{#endsyntax#} or {#syntax#}b{#endsyntax#} based on {#syntax#}pred{#endsyntax#}. If {#syntax#}pred[i]{#endsyntax#} is {#syntax#}true{#endsyntax#}, the corresponding element in the result will be {#syntax#}a[i]{#endsyntax#} and otherwise {#syntax#}b[i]{#endsyntax#}.
</p>
Add Vector documentation (#10303) * Create Vector language documentation Main changes to docs: 1. Create brief documentation on Zig vector types with code example 2. Get rid of the SIMD sub-heading under the main Vectors heading, and update links accordingly 3. Add an example to the `@shuffle` docs
2021-12-19 04:40:57 +00:00
{#see_also|Vectors#}
Add @select @select( comptime T: type, pred: std.meta.Vector(len, bool), a: std.meta.Vector(len, T), b: std.meta.Vector(len, T) ) std.meta.Vector(len, T) Constructs a vector from a & b, based on the values in the predicate vector. For indices where the predicate value is true, the corresponding element from the a vector is selected, and otherwise from b.
2021-07-26 00:37:11 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@setEvalBranchQuota#}
langref: add missing return types to builtin functions This should add all remaining missing return types to all builtin functions. For @clz, @ctz, and @popCount it uses anytype for the lack of a better alternative. We already use this return type for other builtin functions in the langref to indicate that the type is not always the same. It is not possible to use anytype as the return type for regular functions but builtin functions are special.
2023-03-03 15:16:08 +00:00
<pre>{#syntax#}@setEvalBranchQuota(comptime new_quota: u32) void{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
Increase the maximum number of backwards branches that compile-time code
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
execution can use before giving up and making a compile error.
</p>
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
If the {#syntax#}new_quota{#endsyntax#} is smaller than the default quota ({#syntax#}1000{#endsyntax#}) or
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
a previously explicitly set quota, it is ignored.
</p>
<p>
Example:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_without_setEvalBranchQuota_builtin.zig#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<p>Now we use {#syntax#}@setEvalBranchQuota{#endsyntax#}:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_setEvalBranchQuota_builtin.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|comptime#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@setFloatMode#}
langref: make more consistent * moves some langref into std.builtin doc comments * use the same way of referencing stuff from std.builtin closes #16483
2024-01-22 03:39:50 +00:00
<pre>{#syntax#}@setFloatMode(comptime mode: FloatMode) void{#endsyntax#}</pre>
<p>Changes the current scope's rules about how floating point operations are defined.</p>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
remove the scope parameter of setFloatMode also document that scopes inherit this value. See #367 See #1283
2018-09-13 19:46:34 +00:00
<li>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}Strict{#endsyntax#} (default) - Floating point operations follow strict IEEE compliance.
remove the scope parameter of setFloatMode also document that scopes inherit this value. See #367 See #1283
2018-09-13 19:46:34 +00:00
</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<li>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}Optimized{#endsyntax#} - Floating point operations may do all of the following:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
<li>Assume the arguments and result are not NaN. Optimizations are required to retain defined behavior over NaNs, but the value of the result is undefined.</li>
<li>Assume the arguments and result are not +/-Inf. Optimizations are required to retain defined behavior over +/-Inf, but the value of the result is undefined.</li>
<li>Treat the sign of a zero argument or result as insignificant.</li>
<li>Use the reciprocal of an argument rather than perform division.</li>
fix(text): hyphenation and other fixes
2022-10-03 17:52:39 +00:00
<li>Perform floating-point contraction (e.g. fusing a multiply followed by an addition into a fused multiply-add).</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<li>Perform algebraically equivalent transformations that may change results in floating point (e.g. reassociate).</li>
</ul>
This is equivalent to <code>-ffast-math</code> in GCC.
</li>
</ul>
remove the scope parameter of setFloatMode also document that scopes inherit this value. See #367 See #1283
2018-09-13 19:46:34 +00:00
<p>
The floating point mode is inherited by child scopes, and can be overridden in any scope.
You can set the floating point mode in a struct or module scope by using a comptime block.
</p>
langref: make more consistent * moves some langref into std.builtin doc comments * use the same way of referencing stuff from std.builtin closes #16483
2024-01-22 03:39:50 +00:00
<p>{#syntax#}FloatMode{#endsyntax#} can be found with {#syntax#}@import("std").builtin.FloatMode{#endsyntax#}.</p>
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|Floating Point Operations#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
{#header_open|@setRuntimeSafety#}
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
<pre>{#syntax#}@setRuntimeSafety(comptime safety_on: bool) void{#endsyntax#}</pre>
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
<p>
fix @setRuntimeSafety not able to override release modes
2019-03-13 18:46:53 +00:00
Sets whether runtime safety checks are enabled for the scope that contains the function call.
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_setRuntimeSafety_builtin.zig#}
docs: add note to @setRuntimeSafety
2019-05-01 19:09:03 +00:00
<p>Note: it is <a href="https://github.com/ziglang/zig/issues/978">planned</a> to replace
{#syntax#}@setRuntimeSafety{#endsyntax#} with <code>@optimizeFor</code></p>
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@shlExact#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}@shlExact(value: T, shift_amt: Log2T) T{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
saturating arithmetic modifications * Remove the builtins `@addWithSaturation`, `@subWithSaturation`, `@mulWithSaturation`, and `@shlWithSaturation` now that we have first-class syntax for saturating arithmetic. * langref: Clarify the behavior of `@shlExact`. * Ast: rename `bit_shift_left` to `shl` and `bit_shift_right` to `shr` for consistency. * Air: rename to include underscore separator with consistency with the rest of the ops. * Air: add shl_exact instruction * Use non-extended tags for saturating arithmetic, to keep it simple so that all the arithmetic operations can be done the same way. - Sema: unify analyzeArithmetic with analyzeSatArithmetic - implement comptime `+|`, `-|`, and `*|` - allow float operands to saturating arithmetic * `<<|` allows any integer type for the RHS. * C backend: fix rebase conflicts * LLVM backend: reduce the amount of branching for arithmetic ops * zig.h: fix magic number not matching actual size of C integer types
2021-09-29 01:55:43 +00:00
Performs the left shift operation ({#syntax#}<<{#endsyntax#}).
For unsigned integers, the result is {#link|undefined#} if any 1 bits
are shifted out. For signed integers, the result is {#link|undefined#} if
any bits that disagree with the resultant sign bit are shifted out.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
std: update `std.builtin.Type` fields to follow naming conventions The compiler actually doesn't need any functional changes for this: Sema does reification based on the tag indices of `std.builtin.Type` already! So, no zig1.wasm update is necessary. This change is necessary to disallow name clashes between fields and decls on a type, which is a prerequisite of #9938.
2024-08-28 01:35:53 +00:00
The type of {#syntax#}shift_amt{#endsyntax#} is an unsigned integer with {#syntax#}log2(@typeInfo(T).int.bits){#endsyntax#} bits.
This is because {#syntax#}shift_amt >= @typeInfo(T).int.bits{#endsyntax#} is undefined behavior.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
`@shlExact` fixups * Add clarification in langref * move test case to behavior tests
2024-01-04 07:44:44 +00:00
<p>
{#syntax#}comptime_int{#endsyntax#} is modeled as an integer with an infinite number of bits,
meaning that in such case, {#syntax#}@shlExact{#endsyntax#} always produces a result and
cannot produce a compile error.
</p>
saturating arithmetic modifications * Remove the builtins `@addWithSaturation`, `@subWithSaturation`, `@mulWithSaturation`, and `@shlWithSaturation` now that we have first-class syntax for saturating arithmetic. * langref: Clarify the behavior of `@shlExact`. * Ast: rename `bit_shift_left` to `shl` and `bit_shift_right` to `shr` for consistency. * Air: rename to include underscore separator with consistency with the rest of the ops. * Air: add shl_exact instruction * Use non-extended tags for saturating arithmetic, to keep it simple so that all the arithmetic operations can be done the same way. - Sema: unify analyzeArithmetic with analyzeSatArithmetic - implement comptime `+|`, `-|`, and `*|` - allow float operands to saturating arithmetic * `<<|` allows any integer type for the RHS. * C backend: fix rebase conflicts * LLVM backend: reduce the amount of branching for arithmetic ops * zig.h: fix magic number not matching actual size of C integer types
2021-09-29 01:55:43 +00:00
{#see_also|@shrExact|@shlWithOverflow#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@shlWithOverflow#}
update uses of overflow arithmetic builtins
2022-12-21 14:40:30 +00:00
<pre>{#syntax#}@shlWithOverflow(a: anytype, shift_amt: Log2T) struct { @TypeOf(a), u1 }{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
update uses of overflow arithmetic builtins
2022-12-21 14:40:30 +00:00
Performs {#syntax#}a << b{#endsyntax#} and returns a tuple with the result and a possible overflow bit.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
std: update `std.builtin.Type` fields to follow naming conventions The compiler actually doesn't need any functional changes for this: Sema does reification based on the tag indices of `std.builtin.Type` already! So, no zig1.wasm update is necessary. This change is necessary to disallow name clashes between fields and decls on a type, which is a prerequisite of #9938.
2024-08-28 01:35:53 +00:00
The type of {#syntax#}shift_amt{#endsyntax#} is an unsigned integer with {#syntax#}log2(@typeInfo(@TypeOf(a)).int.bits){#endsyntax#} bits.
This is because {#syntax#}shift_amt >= @typeInfo(@TypeOf(a)).int.bits{#endsyntax#} is undefined behavior.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
saturating arithmetic modifications * Remove the builtins `@addWithSaturation`, `@subWithSaturation`, `@mulWithSaturation`, and `@shlWithSaturation` now that we have first-class syntax for saturating arithmetic. * langref: Clarify the behavior of `@shlExact`. * Ast: rename `bit_shift_left` to `shl` and `bit_shift_right` to `shr` for consistency. * Air: rename to include underscore separator with consistency with the rest of the ops. * Air: add shl_exact instruction * Use non-extended tags for saturating arithmetic, to keep it simple so that all the arithmetic operations can be done the same way. - Sema: unify analyzeArithmetic with analyzeSatArithmetic - implement comptime `+|`, `-|`, and `*|` - allow float operands to saturating arithmetic * `<<|` allows any integer type for the RHS. * C backend: fix rebase conflicts * LLVM backend: reduce the amount of branching for arithmetic ops * zig.h: fix magic number not matching actual size of C integer types
2021-09-29 01:55:43 +00:00
{#see_also|@shlExact|@shrExact#}
saturating arithmetic builtins: add, sub, mul, shl (#9619) - adds 1 simple behavior tests for each which does integer and vector ops at runtime and comptime - adds bigint_*_sat() methods for each - use CreateIntrinsic() which accepts a variable number of arguments to pass the scale parameter * update langref - added case to test/compile_errors.zig given floats - explain upstream bug in llvm.smul.fix.sat and link to #9643 in langref and commented out test cases * sat-arithmetic: skip mul tests if arch == .wasm32 because ci is erroring with 'LLVM ERROR: Unable to expand fixed point multiplication' when compiling for wasm32
2021-09-01 18:17:45 +00:00
{#header_close#}
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@shrExact#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}@shrExact(value: T, shift_amt: Log2T) T{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Performs the right shift operation ({#syntax#}>>{#endsyntax#}). Caller guarantees
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
that the shift will not shift any 1 bits out.
</p>
<p>
std: update `std.builtin.Type` fields to follow naming conventions The compiler actually doesn't need any functional changes for this: Sema does reification based on the tag indices of `std.builtin.Type` already! So, no zig1.wasm update is necessary. This change is necessary to disallow name clashes between fields and decls on a type, which is a prerequisite of #9938.
2024-08-28 01:35:53 +00:00
The type of {#syntax#}shift_amt{#endsyntax#} is an unsigned integer with {#syntax#}log2(@typeInfo(T).int.bits){#endsyntax#} bits.
This is because {#syntax#}shift_amt >= @typeInfo(T).int.bits{#endsyntax#} is undefined behavior.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
saturating arithmetic modifications * Remove the builtins `@addWithSaturation`, `@subWithSaturation`, `@mulWithSaturation`, and `@shlWithSaturation` now that we have first-class syntax for saturating arithmetic. * langref: Clarify the behavior of `@shlExact`. * Ast: rename `bit_shift_left` to `shl` and `bit_shift_right` to `shr` for consistency. * Air: rename to include underscore separator with consistency with the rest of the ops. * Air: add shl_exact instruction * Use non-extended tags for saturating arithmetic, to keep it simple so that all the arithmetic operations can be done the same way. - Sema: unify analyzeArithmetic with analyzeSatArithmetic - implement comptime `+|`, `-|`, and `*|` - allow float operands to saturating arithmetic * `<<|` allows any integer type for the RHS. * C backend: fix rebase conflicts * LLVM backend: reduce the amount of branching for arithmetic ops * zig.h: fix magic number not matching actual size of C integer types
2021-09-29 01:55:43 +00:00
{#see_also|@shlExact|@shlWithOverflow#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
remove []u8 casting syntax. add `@bytesToSlice` and `@sliceToBytes` See #1061
2018-06-18 21:25:29 +00:00
rework the implementation * update documentation - move `@shuffle` to be sorted alphabetically - remove mention of LLVM - minor clarifications & rewording * introduce ir_resolve_vector_elem_type to avoid duplicate compile error message and duplicate vector element checking logic * rework ir_analyze_shuffle_vector to solve various issues * improve `@shuffle` to allow implicit cast of arrays * the shuffle tests weren't being run
2019-09-18 19:41:56 +00:00
{#header_open|@shuffle#}
basic language features do not belong in std.meta
2022-03-14 05:21:16 +00:00
<pre>{#syntax#}@shuffle(comptime E: type, a: @Vector(a_len, E), b: @Vector(b_len, E), comptime mask: @Vector(mask_len, i32)) @Vector(mask_len, E){#endsyntax#}</pre>
rework the implementation * update documentation - move `@shuffle` to be sorted alphabetically - remove mention of LLVM - minor clarifications & rewording * introduce ir_resolve_vector_elem_type to avoid duplicate compile error message and duplicate vector element checking logic * rework ir_analyze_shuffle_vector to solve various issues * improve `@shuffle` to allow implicit cast of arrays * the shuffle tests weren't being run
2019-09-18 19:41:56 +00:00
<p>
Constructs a new {#link|vector|Vectors#} by selecting elements from {#syntax#}a{#endsyntax#} and
{#syntax#}b{#endsyntax#} based on {#syntax#}mask{#endsyntax#}.
</p>
<p>
Each element in {#syntax#}mask{#endsyntax#} selects an element from either {#syntax#}a{#endsyntax#} or
{#syntax#}b{#endsyntax#}. Positive numbers select from {#syntax#}a{#endsyntax#} starting at 0.
Negative values select from {#syntax#}b{#endsyntax#}, starting at {#syntax#}-1{#endsyntax#} and going down.
Fix minor langref typos
2022-09-24 18:42:00 +00:00
It is recommended to use the {#syntax#}~{#endsyntax#} operator for indexes from {#syntax#}b{#endsyntax#}
Update the docs to use `@as`
2019-12-03 10:56:50 +00:00
so that both indexes can start from {#syntax#}0{#endsyntax#} (i.e. {#syntax#}~@as(i32, 0){#endsyntax#} is
rework the implementation * update documentation - move `@shuffle` to be sorted alphabetically - remove mention of LLVM - minor clarifications & rewording * introduce ir_resolve_vector_elem_type to avoid duplicate compile error message and duplicate vector element checking logic * rework ir_analyze_shuffle_vector to solve various issues * improve `@shuffle` to allow implicit cast of arrays * the shuffle tests weren't being run
2019-09-18 19:41:56 +00:00
{#syntax#}-1{#endsyntax#}).
</p>
<p>
For each element of {#syntax#}mask{#endsyntax#}, if it or the selected value from
{#syntax#}a{#endsyntax#} or {#syntax#}b{#endsyntax#} is {#syntax#}undefined{#endsyntax#},
then the resulting element is {#syntax#}undefined{#endsyntax#}.
</p>
<p>
{#syntax#}a_len{#endsyntax#} and {#syntax#}b_len{#endsyntax#} may differ in length. Out-of-bounds element
indexes in {#syntax#}mask{#endsyntax#} result in compile errors.
</p>
<p>
If {#syntax#}a{#endsyntax#} or {#syntax#}b{#endsyntax#} is {#syntax#}undefined{#endsyntax#}, it
is equivalent to a vector of all {#syntax#}undefined{#endsyntax#} with the same length as the other vector.
If both vectors are {#syntax#}undefined{#endsyntax#}, {#syntax#}@shuffle{#endsyntax#} returns
a vector with all elements {#syntax#}undefined{#endsyntax#}.
</p>
<p>
{#syntax#}E{#endsyntax#} must be an {#link|integer|Integers#}, {#link|float|Floats#},
{#link|pointer|Pointers#}, or {#syntax#}bool{#endsyntax#}. The mask may be any vector length, and its
length determines the result length.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_shuffle_builtin.zig#}
Add Vector documentation (#10303) * Create Vector language documentation Main changes to docs: 1. Create brief documentation on Zig vector types with code example 2. Get rid of the SIMD sub-heading under the main Vectors heading, and update links accordingly 3. Add an example to the `@shuffle` docs
2021-12-19 04:40:57 +00:00
{#see_also|Vectors#}
rework the implementation * update documentation - move `@shuffle` to be sorted alphabetically - remove mention of LLVM - minor clarifications & rewording * introduce ir_resolve_vector_elem_type to avoid duplicate compile error message and duplicate vector element checking logic * rework ir_analyze_shuffle_vector to solve various issues * improve `@shuffle` to allow implicit cast of arrays * the shuffle tests weren't being run
2019-09-18 19:41:56 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@sizeOf#}
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<pre>{#syntax#}@sizeOf(comptime T: type) comptime_int{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
This function returns the number of bytes it takes to store {#syntax#}T{#endsyntax#} in memory.
breaking: fix @sizeOf to be alloc size rather than store size * Fixes breaches of the guarantee that `@sizeOf(T) >= @alignOf(T)` * Fixes std.mem.secureZero for integers where this guarantee previously was breached * Fixes std.mem.Allocator for integers where this guarantee previously was breached Closes #1851 Closes #1864
2019-02-15 23:05:50 +00:00
The result is a target-specific compile time constant.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
This size may contain padding bytes. If there were two consecutive T in memory, the padding would be the offset
breaking: fix @sizeOf to be alloc size rather than store size * Fixes breaches of the guarantee that `@sizeOf(T) >= @alignOf(T)` * Fixes std.mem.secureZero for integers where this guarantee previously was breached * Fixes std.mem.Allocator for integers where this guarantee previously was breached Closes #1851 Closes #1864
2019-02-15 23:05:50 +00:00
in bytes between element at index 0 and the element at index 1. For {#link|integer|Integers#},
consider whether you want to use {#syntax#}@sizeOf(T){#endsyntax#} or
std: update `std.builtin.Type` fields to follow naming conventions The compiler actually doesn't need any functional changes for this: Sema does reification based on the tag indices of `std.builtin.Type` already! So, no zig1.wasm update is necessary. This change is necessary to disallow name clashes between fields and decls on a type, which is a prerequisite of #9938.
2024-08-28 01:35:53 +00:00
{#syntax#}@typeInfo(T).int.bits{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
`@sizeOf` returns 0 for comptime types This defines `@sizeOf` to be the runtime size of a type, which means that it is zero for types such as comptime_int, type, and (enum literal). See #2209
2019-04-25 02:31:53 +00:00
<p>
This function measures the size at runtime. For types that are disallowed at runtime, such as
{#syntax#}comptime_int{#endsyntax#} and {#syntax#}type{#endsyntax#}, the result is {#syntax#}0{#endsyntax#}.
</p>
implement `@bitSizeOf`
2020-01-16 15:12:43 +00:00
{#see_also|@bitSizeOf|@typeInfo#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
remove []u8 casting syntax. add `@bytesToSlice` and `@sliceToBytes` See #1061
2018-06-18 21:25:29 +00:00
add docs for `@splat`
2019-09-19 15:14:42 +00:00
{#header_open|@splat#}
Update langref to new splat syntax
2023-07-07 19:52:43 +00:00
<pre>{#syntax#}@splat(scalar: anytype) anytype{#endsyntax#}</pre>
add docs for `@splat`
2019-09-19 15:14:42 +00:00
<p>
langref: small fixes to wording and examples Simplify wording and add some formatting in several locations. Expand sentinel array tests to highlight (non-)handling of internal sentinels. Fix format of symbol names in function pointers example. Clarify wording a bit on the builin atomic* documentation. Remove the (second) builtin compileLog example that demonstrated a lack of compileLog entries. * langref: address comments from rohlem Use "0-terminated" instead of "null-terminated". Undo some changes that were not as clear an improvement as I though. * langref: remove stray "&#14;" Thanks to rohlem for spotting this typo.
2023-09-21 14:50:48 +00:00
Produces a vector where each element is the value {#syntax#}scalar{#endsyntax#}.
Update langref to new splat syntax
2023-07-07 19:52:43 +00:00
The return type and thus the length of the vector is inferred.
add docs for `@splat`
2019-09-19 15:14:42 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_splat_builtin.zig#}
add docs for `@splat`
2019-09-19 15:14:42 +00:00
<p>
{#syntax#}scalar{#endsyntax#} must be an {#link|integer|Integers#}, {#link|bool|Primitive Types#},
{#link|float|Floats#}, or {#link|pointer|Pointers#}.
</p>
{#see_also|Vectors|@shuffle#}
{#header_close#}
docs: Add @reduce documentation
2020-11-01 18:51:59 +00:00
{#header_open|@reduce#}
langref: small clarification of `@reduce`
2022-03-18 00:22:57 +00:00
<pre>{#syntax#}@reduce(comptime op: std.builtin.ReduceOp, value: anytype) E{#endsyntax#}</pre>
docs: Add @reduce documentation
2020-11-01 18:51:59 +00:00
<p>
langref: small clarification of `@reduce`
2022-03-18 00:22:57 +00:00
Transforms a {#link|vector|Vectors#} into a scalar value (of type <code>E</code>)
by performing a sequential horizontal reduction of its elements using the
specified operator {#syntax#}op{#endsyntax#}.
docs: Add @reduce documentation
2020-11-01 18:51:59 +00:00
</p>
<p>
Not every operator is available for every vector element type:
langref tidy html fixup
2020-11-01 21:39:45 +00:00
</p>
docs: Add @reduce documentation
2020-11-01 18:51:59 +00:00
<ul>
langref: small clarification of `@reduce`
2022-03-18 00:22:57 +00:00
<li>Every operator is available for {#link|integer|Integers#} vectors.</li>
docs: Add @reduce documentation
2020-11-01 18:51:59 +00:00
<li>{#syntax#}.And{#endsyntax#}, {#syntax#}.Or{#endsyntax#},
langref: small clarification of `@reduce`
2022-03-18 00:22:57 +00:00
{#syntax#}.Xor{#endsyntax#} are additionally available for
docs: Add @reduce documentation
2020-11-01 18:51:59 +00:00
{#syntax#}bool{#endsyntax#} vectors,</li>
<li>{#syntax#}.Min{#endsyntax#}, {#syntax#}.Max{#endsyntax#},
{#syntax#}.Add{#endsyntax#}, {#syntax#}.Mul{#endsyntax#} are
langref: small clarification of `@reduce`
2022-03-18 00:22:57 +00:00
additionally available for {#link|floating point|Floats#} vectors,</li>
docs: Add @reduce documentation
2020-11-01 18:51:59 +00:00
</ul>
<p>
Note that {#syntax#}.Add{#endsyntax#} and {#syntax#}.Mul{#endsyntax#}
reductions on integral types are wrapping; when applied on floating point
types the operation associativity is preserved, unless the float mode is
set to {#syntax#}Optimized{#endsyntax#}.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_reduce_builtin.zig#}
docs: Add @reduce documentation
2020-11-01 18:51:59 +00:00
{#see_also|Vectors|@setFloatMode#}
{#header_close#}
Add documentation for @src() builtin
2020-07-01 01:52:02 +00:00
{#header_open|@src#}
<pre>{#syntax#}@src() std.builtin.SourceLocation{#endsyntax#}</pre>
<p>
Returns a {#syntax#}SourceLocation{#endsyntax#} struct representing the function's name and location in the source code. This must be called in a function.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_src_builtin.zig#}
add docs for `@splat`
2019-09-19 15:14:42 +00:00
Add documentation for @src() builtin
2020-07-01 01:52:02 +00:00
{#header_close#}
add @sqrt built-in function See #767
2018-04-15 17:21:52 +00:00
{#header_open|@sqrt#}
add 'anytype' to stage1 and langref
2020-07-11 11:08:20 +00:00
<pre>{#syntax#}@sqrt(value: anytype) @TypeOf(value){#endsyntax#}</pre>
add @sqrt built-in function See #767
2018-04-15 17:21:52 +00:00
<p>
Performs the square root of a floating point number. Uses a dedicated hardware instruction
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
when available.
</p>
<p>
langref: remove link to closed issue #4026 In the math builtin functions documentation, remove the link to issue https://github.com/ziglang/zig/issues/4026, since it was closed by https://github.com/ziglang/zig/pull/11532.
2023-02-02 14:11:13 +00:00
Supports {#link|Floats#} and {#link|Vectors#} of floats.
add @sqrt built-in function See #767
2018-04-15 17:21:52 +00:00
</p>
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
{#header_close#}
{#header_open|@sin#}
add 'anytype' to stage1 and langref
2020-07-11 11:08:20 +00:00
<pre>{#syntax#}@sin(value: anytype) @TypeOf(value){#endsyntax#}</pre>
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
<p>
Clarify @sin, @cos, @tan use radians
2023-06-13 20:37:26 +00:00
Sine trigonometric function on a floating point number in radians. Uses a dedicated hardware instruction
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
when available.
</p>
<p>
langref: remove link to closed issue #4026 In the math builtin functions documentation, remove the link to issue https://github.com/ziglang/zig/issues/4026, since it was closed by https://github.com/ziglang/zig/pull/11532.
2023-02-02 14:11:13 +00:00
Supports {#link|Floats#} and {#link|Vectors#} of floats.
add @sqrt built-in function See #767
2018-04-15 17:21:52 +00:00
</p>
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
{#header_close#}
add new builtin function `@tan` The reason for having `@tan` is that we already have `@sin` and `@cos` because some targets have machine code instructions for them, but in the case that the implementation needs to go into compiler-rt, sin, cos, and tan all share a common dependency which includes a table of data. To avoid duplicating this table of data, we promote tan to become a builtin alongside sin and cos. ZIR: The tag enum is at capacity so this commit moves `field_call_bind_named` to be `extended`. I measured this as one of the least used tags in the zig codebase. Fix libc math suffix for `f32` being wrong in both stage1 and stage2. stage1: add missing libc prefix for float functions.
2022-04-27 23:45:23 +00:00
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
{#header_open|@cos#}
add 'anytype' to stage1 and langref
2020-07-11 11:08:20 +00:00
<pre>{#syntax#}@cos(value: anytype) @TypeOf(value){#endsyntax#}</pre>
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
<p>
Clarify @sin, @cos, @tan use radians
2023-06-13 20:37:26 +00:00
Cosine trigonometric function on a floating point number in radians. Uses a dedicated hardware instruction
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
when available.
</p>
<p>
langref: remove link to closed issue #4026 In the math builtin functions documentation, remove the link to issue https://github.com/ziglang/zig/issues/4026, since it was closed by https://github.com/ziglang/zig/pull/11532.
2023-02-02 14:11:13 +00:00
Supports {#link|Floats#} and {#link|Vectors#} of floats.
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
</p>
{#header_close#}
add new builtin function `@tan` The reason for having `@tan` is that we already have `@sin` and `@cos` because some targets have machine code instructions for them, but in the case that the implementation needs to go into compiler-rt, sin, cos, and tan all share a common dependency which includes a table of data. To avoid duplicating this table of data, we promote tan to become a builtin alongside sin and cos. ZIR: The tag enum is at capacity so this commit moves `field_call_bind_named` to be `extended`. I measured this as one of the least used tags in the zig codebase. Fix libc math suffix for `f32` being wrong in both stage1 and stage2. stage1: add missing libc prefix for float functions.
2022-04-27 23:45:23 +00:00
{#header_open|@tan#}
<pre>{#syntax#}@tan(value: anytype) @TypeOf(value){#endsyntax#}</pre>
<p>
Clarify @sin, @cos, @tan use radians
2023-06-13 20:37:26 +00:00
Tangent trigonometric function on a floating point number in radians.
add new builtin function `@tan` The reason for having `@tan` is that we already have `@sin` and `@cos` because some targets have machine code instructions for them, but in the case that the implementation needs to go into compiler-rt, sin, cos, and tan all share a common dependency which includes a table of data. To avoid duplicating this table of data, we promote tan to become a builtin alongside sin and cos. ZIR: The tag enum is at capacity so this commit moves `field_call_bind_named` to be `extended`. I measured this as one of the least used tags in the zig codebase. Fix libc math suffix for `f32` being wrong in both stage1 and stage2. stage1: add missing libc prefix for float functions.
2022-04-27 23:45:23 +00:00
Uses a dedicated hardware instruction when available.
</p>
<p>
langref: remove link to closed issue #4026 In the math builtin functions documentation, remove the link to issue https://github.com/ziglang/zig/issues/4026, since it was closed by https://github.com/ziglang/zig/pull/11532.
2023-02-02 14:11:13 +00:00
Supports {#link|Floats#} and {#link|Vectors#} of floats.
add new builtin function `@tan` The reason for having `@tan` is that we already have `@sin` and `@cos` because some targets have machine code instructions for them, but in the case that the implementation needs to go into compiler-rt, sin, cos, and tan all share a common dependency which includes a table of data. To avoid duplicating this table of data, we promote tan to become a builtin alongside sin and cos. ZIR: The tag enum is at capacity so this commit moves `field_call_bind_named` to be `extended`. I measured this as one of the least used tags in the zig codebase. Fix libc math suffix for `f32` being wrong in both stage1 and stage2. stage1: add missing libc prefix for float functions.
2022-04-27 23:45:23 +00:00
</p>
{#header_close#}
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
{#header_open|@exp#}
add 'anytype' to stage1 and langref
2020-07-11 11:08:20 +00:00
<pre>{#syntax#}@exp(value: anytype) @TypeOf(value){#endsyntax#}</pre>
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
<p>
Base-e exponential function on a floating point number. Uses a dedicated hardware instruction
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
when available.
</p>
<p>
langref: remove link to closed issue #4026 In the math builtin functions documentation, remove the link to issue https://github.com/ziglang/zig/issues/4026, since it was closed by https://github.com/ziglang/zig/pull/11532.
2023-02-02 14:11:13 +00:00
Supports {#link|Floats#} and {#link|Vectors#} of floats.
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
</p>
{#header_close#}
{#header_open|@exp2#}
add 'anytype' to stage1 and langref
2020-07-11 11:08:20 +00:00
<pre>{#syntax#}@exp2(value: anytype) @TypeOf(value){#endsyntax#}</pre>
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
<p>
Base-2 exponential function on a floating point number. Uses a dedicated hardware instruction
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
when available.
</p>
<p>
langref: remove link to closed issue #4026 In the math builtin functions documentation, remove the link to issue https://github.com/ziglang/zig/issues/4026, since it was closed by https://github.com/ziglang/zig/pull/11532.
2023-02-02 14:11:13 +00:00
Supports {#link|Floats#} and {#link|Vectors#} of floats.
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
</p>
{#header_close#}
fix comptime vector float ops and add test coverage also rename `@ln` to `@log` to match libc convention.
2020-01-02 19:01:48 +00:00
{#header_open|@log#}
add 'anytype' to stage1 and langref
2020-07-11 11:08:20 +00:00
<pre>{#syntax#}@log(value: anytype) @TypeOf(value){#endsyntax#}</pre>
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
<p>
Returns the natural logarithm of a floating point number. Uses a dedicated hardware instruction
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
when available.
</p>
<p>
langref: remove link to closed issue #4026 In the math builtin functions documentation, remove the link to issue https://github.com/ziglang/zig/issues/4026, since it was closed by https://github.com/ziglang/zig/pull/11532.
2023-02-02 14:11:13 +00:00
Supports {#link|Floats#} and {#link|Vectors#} of floats.
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
</p>
{#header_close#}
{#header_open|@log2#}
add 'anytype' to stage1 and langref
2020-07-11 11:08:20 +00:00
<pre>{#syntax#}@log2(value: anytype) @TypeOf(value){#endsyntax#}</pre>
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
<p>
Returns the logarithm to the base 2 of a floating point number. Uses a dedicated hardware instruction
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
when available.
</p>
<p>
langref: remove link to closed issue #4026 In the math builtin functions documentation, remove the link to issue https://github.com/ziglang/zig/issues/4026, since it was closed by https://github.com/ziglang/zig/pull/11532.
2023-02-02 14:11:13 +00:00
Supports {#link|Floats#} and {#link|Vectors#} of floats.
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
</p>
{#header_close#}
{#header_open|@log10#}
add 'anytype' to stage1 and langref
2020-07-11 11:08:20 +00:00
<pre>{#syntax#}@log10(value: anytype) @TypeOf(value){#endsyntax#}</pre>
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
<p>
Returns the logarithm to the base 10 of a floating point number. Uses a dedicated hardware instruction
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
when available.
</p>
<p>
langref: remove link to closed issue #4026 In the math builtin functions documentation, remove the link to issue https://github.com/ziglang/zig/issues/4026, since it was closed by https://github.com/ziglang/zig/pull/11532.
2023-02-02 14:11:13 +00:00
Supports {#link|Floats#} and {#link|Vectors#} of floats.
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
</p>
{#header_close#}
Change `@fabs` to `@abs` in langref
2023-07-18 00:19:03 +00:00
{#header_open|@abs#}
<pre>{#syntax#}@abs(value: anytype) anytype{#endsyntax#}</pre>
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
<p>
Change `@fabs` to `@abs` in langref
2023-07-18 00:19:03 +00:00
Returns the absolute value of an integer or a floating point number. Uses a dedicated hardware instruction
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
when available.
Change `@fabs` to `@abs` in langref
2023-07-18 00:19:03 +00:00
The return type is always an unsigned integer of the same bit width as the operand if the operand is an integer.
Unsigned integer operands are supported. The builtin cannot overflow for signed integer operands.
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
</p>
<p>
Change `@fabs` to `@abs` in langref
2023-07-18 00:19:03 +00:00
Supports {#link|Floats#}, {#link|Integers#} and {#link|Vectors#} of floats or integers.
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
</p>
{#header_close#}
{#header_open|@floor#}
add 'anytype' to stage1 and langref
2020-07-11 11:08:20 +00:00
<pre>{#syntax#}@floor(value: anytype) @TypeOf(value){#endsyntax#}</pre>
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
<p>
Returns the largest integral value not greater than the given floating point number.
Uses a dedicated hardware instruction when available.
</p>
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
<p>
langref: remove link to closed issue #4026 In the math builtin functions documentation, remove the link to issue https://github.com/ziglang/zig/issues/4026, since it was closed by https://github.com/ziglang/zig/pull/11532.
2023-02-02 14:11:13 +00:00
Supports {#link|Floats#} and {#link|Vectors#} of floats.
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
</p>
{#header_close#}
{#header_open|@ceil#}
add 'anytype' to stage1 and langref
2020-07-11 11:08:20 +00:00
<pre>{#syntax#}@ceil(value: anytype) @TypeOf(value){#endsyntax#}</pre>
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
<p>
Fix a typo in @ceil documentation.
2021-09-30 04:19:23 +00:00
Returns the smallest integral value not less than the given floating point number.
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
Uses a dedicated hardware instruction when available.
</p>
<p>
langref: remove link to closed issue #4026 In the math builtin functions documentation, remove the link to issue https://github.com/ziglang/zig/issues/4026, since it was closed by https://github.com/ziglang/zig/pull/11532.
2023-02-02 14:11:13 +00:00
Supports {#link|Floats#} and {#link|Vectors#} of floats.
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
</p>
{#header_close#}
{#header_open|@trunc#}
add 'anytype' to stage1 and langref
2020-07-11 11:08:20 +00:00
<pre>{#syntax#}@trunc(value: anytype) @TypeOf(value){#endsyntax#}</pre>
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
<p>
Rounds the given floating point number to an integer, towards zero.
Uses a dedicated hardware instruction when available.
</p>
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
<p>
langref: remove link to closed issue #4026 In the math builtin functions documentation, remove the link to issue https://github.com/ziglang/zig/issues/4026, since it was closed by https://github.com/ziglang/zig/pull/11532.
2023-02-02 14:11:13 +00:00
Supports {#link|Floats#} and {#link|Vectors#} of floats.
stage1: add @sin @cos @exp @exp2 @ln @log2 @log10 @fabs @floor @ceil @trunc @round and expand @sqrt This revealed that the accuracy of ln is not as good as the current algorithm in musl and glibc, and should be ported again. v2: actually include tests v3: fix reversal of in and out arguments on f128M_sqrt() add test for @sqrt on comptime_float do not include @nearbyInt() until it works on all targets.
2019-06-21 21:18:59 +00:00
</p>
{#header_close#}
{#header_open|@round#}
add 'anytype' to stage1 and langref
2020-07-11 11:08:20 +00:00
<pre>{#syntax#}@round(value: anytype) @TypeOf(value){#endsyntax#}</pre>
add @sqrt built-in function See #767
2018-04-15 17:21:52 +00:00
<p>
langref: clarify functionality of the round builtin (#19503) A test has also been added to demonstrate the expected behavior. * std.math: update round doc comment to match the builtin
2024-08-14 17:29:45 +00:00
Rounds the given floating point number to the nearest integer. If two integers are equally close, rounds away from zero.
Uses a dedicated hardware instruction when available.
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
</p>
langref: clarify functionality of the round builtin (#19503) A test has also been added to demonstrate the expected behavior. * std.math: update round doc comment to match the builtin
2024-08-14 17:29:45 +00:00
{#code|test_round_builtin.zig#}
fix float ops with respect to vectors also remove the redundant type parameter
2020-01-02 04:27:43 +00:00
<p>
langref: remove link to closed issue #4026 In the math builtin functions documentation, remove the link to issue https://github.com/ziglang/zig/issues/4026, since it was closed by https://github.com/ziglang/zig/pull/11532.
2023-02-02 14:11:13 +00:00
Supports {#link|Floats#} and {#link|Vectors#} of floats.
add @sqrt built-in function See #767
2018-04-15 17:21:52 +00:00
</p>
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@subWithOverflow#}
update uses of overflow arithmetic builtins
2022-12-21 14:40:30 +00:00
<pre>{#syntax#}@subWithOverflow(a: anytype, b: anytype) struct { @TypeOf(a, b), u1 }{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
update uses of overflow arithmetic builtins
2022-12-21 14:40:30 +00:00
Performs {#syntax#}a - b{#endsyntax#} and returns a tuple with the result and a possible overflow bit.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
Various documentation fixes Co-authored-by: Kirk Scheibelhut <kjs@scheibo.com> Co-authored-by: extrasharp <genericpb@gmail.com>
2022-02-04 19:27:50 +00:00
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
{#header_open|@tagName#}
tagName: return a null-terminated slice
2021-04-27 22:57:28 +00:00
<pre>{#syntax#}@tagName(value: anytype) [:0]const u8{#endsyntax#}</pre>
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
<p>
tagName: return a null-terminated slice
2021-04-27 22:57:28 +00:00
Converts an enum value or union value to a string literal representing the name.</p><p>If the enum is non-exhaustive and the tag value does not map to a name, it invokes safety-checked {#link|Undefined Behavior#}.
remove bool to int syntax. add @boolToInt add missing docs See #1061
2018-06-18 07:07:16 +00:00
</p>
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
add docs for `@This()`
2018-09-15 14:14:50 +00:00
{#header_open|@This#}
<pre>{#syntax#}@This() type{#endsyntax#}</pre>
<p>
langref - document that This works on enums too
2020-06-20 11:16:57 +00:00
Returns the innermost struct, enum, or union that this function call is inside.
add docs for `@This()`
2018-09-15 14:14:50 +00:00
This can be useful for an anonymous struct that needs to refer to itself:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_this_builtin.zig#}
add docs for `@This()`
2018-09-15 14:14:50 +00:00
<p>
Docs clarification: local static variable (#8381)
2021-06-23 05:45:36 +00:00
When {#syntax#}@This(){#endsyntax#} is used at file scope, it returns a reference to the
Remove reference to import type (#5279) * Remove reference to import type * Improve language in `@This()` doc
2020-05-05 23:13:35 +00:00
struct that corresponds to the current file.
add docs for `@This()`
2018-09-15 14:14:50 +00:00
</p>
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
add @trap builtin This introduces a new builtin function that compiles down to something that results in an illegal instruction exception/interrupt. It can be used to exit a program abnormally. This implements the builtin for all backends.
2023-03-03 17:35:03 +00:00
{#header_open|@trap#}
<pre>{#syntax#}@trap() noreturn{#endsyntax#}</pre>
<p>
This function inserts a platform-specific trap/jam instruction which can be used to exit the program abnormally.
This may be implemented by explicitly emitting an invalid instruction which may cause an illegal instruction exception of some sort.
Unlike for {#syntax#}@breakpoint(){#endsyntax#}, execution does not continue after this point.
</p>
<p>
langref: small clarification to `@trap`
2023-03-04 21:22:46 +00:00
Outside function scope, this builtin causes a compile error.
add @trap builtin This introduces a new builtin function that compiles down to something that results in an illegal instruction exception/interrupt. It can be used to exit a program abnormally. This implements the builtin for all backends.
2023-03-03 17:35:03 +00:00
</p>
{#see_also|@breakpoint#}
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@truncate#}
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
<pre>{#syntax#}@truncate(integer: anytype) anytype{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
This function truncates bits from an integer type, resulting in a smaller
langref: update to new cast builtin syntax
2023-06-23 18:37:50 +00:00
or same-sized integer type. The return type is the inferred result type.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
docs: reorganize `@truncate` and `@intCast` for clarity
2021-11-28 11:28:47 +00:00
This function always truncates the significant bits of the integer, regardless
of endianness on the target platform.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
docs: reorganize `@truncate` and `@intCast` for clarity
2021-11-28 11:28:47 +00:00
Calling {#syntax#}@truncate{#endsyntax#} on a number out of range of the destination type is well defined and working code:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_truncate_builtin.zig#}
fix outdated/incorrect docs for `@truncate` closes #2234
2019-04-11 02:58:42 +00:00
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: reorganize `@truncate` and `@intCast` for clarity
2021-11-28 11:28:47 +00:00
Use {#link|@intCast#} to convert numbers guaranteed to fit the destination type.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
fixups and add documentation for `@Type`
2019-09-04 15:08:28 +00:00
{#header_open|@Type#}
doc: update std.builtin.TypeInfo to std.builtin.Type
2022-06-25 08:59:17 +00:00
<pre>{#syntax#}@Type(comptime info: std.builtin.Type) type{#endsyntax#}</pre>
fixups and add documentation for `@Type`
2019-09-04 15:08:28 +00:00
<p>
This function is the inverse of {#link|@typeInfo#}. It reifies type information
into a {#syntax#}type{#endsyntax#}.
</p>
<p>
It is available for the following types:
</p>
<ul>
<li>{#syntax#}type{#endsyntax#}</li>
<li>{#syntax#}noreturn{#endsyntax#}</li>
<li>{#syntax#}void{#endsyntax#}</li>
<li>{#syntax#}bool{#endsyntax#}</li>
docs: add html lang and minor fixes
2019-12-05 21:38:59 +00:00
<li>{#link|Integers#} - The maximum bit count for an integer type is {#syntax#}65535{#endsyntax#}.</li>
fixups and add documentation for `@Type`
2019-09-04 15:08:28 +00:00
<li>{#link|Floats#}</li>
<li>{#link|Pointers#}</li>
<li>{#syntax#}comptime_int{#endsyntax#}</li>
<li>{#syntax#}comptime_float{#endsyntax#}</li>
Rename @typeOf to @TypeOf in the language reference
2019-12-09 20:59:42 +00:00
<li>{#syntax#}@TypeOf(undefined){#endsyntax#}</li>
<li>{#syntax#}@TypeOf(null){#endsyntax#}</li>
Update language reference for recent @Type changes
2020-04-28 05:23:13 +00:00
<li>{#link|Arrays#}</li>
<li>{#link|Optionals#}</li>
docs: update implementation status for @Type()
2020-09-23 19:31:57 +00:00
<li>{#link|Error Set Type#}</li>
Update language reference for recent @Type changes
2020-04-28 05:23:13 +00:00
<li>{#link|Error Union Type#}</li>
<li>{#link|Vectors#}</li>
langref: update for opaque {} syntax
2020-09-26 15:05:11 +00:00
<li>{#link|opaque#}</li>
docs: update implementation status for @Type()
2020-09-23 19:31:57 +00:00
<li>{#syntax#}anyframe{#endsyntax#}</li>
<li>{#link|struct#}</li>
<li>{#link|enum#}</li>
<li>{#link|Enum Literals#}</li>
<li>{#link|union#}</li>
langref: update the documentation of @Type @Type is currently available for Functions.
2023-01-25 09:28:14 +00:00
<li>{#link|Functions#}</li>
fixups and add documentation for `@Type`
2019-09-04 15:08:28 +00:00
</ul>
{#header_close#}
Fixed type info test, added documentation.
2018-05-01 10:42:20 +00:00
{#header_open|@typeInfo#}
doc: update std.builtin.TypeInfo to std.builtin.Type
2022-06-25 08:59:17 +00:00
<pre>{#syntax#}@typeInfo(comptime T: type) std.builtin.Type{#endsyntax#}</pre>
Fixed type info test, added documentation.
2018-05-01 10:42:20 +00:00
<p>
remove misleading documentation
2019-12-16 17:07:05 +00:00
Provides type reflection.
Fixed type info test, added documentation.
2018-05-01 10:42:20 +00:00
</p>
docs: update `@typeInfo` definition and clarify field order
2019-04-05 16:37:49 +00:00
<p>
langref: correct info about type info of declarations
2022-02-14 19:26:55 +00:00
Type information of {#link|structs|struct#}, {#link|unions|union#}, {#link|enums|enum#}, and
Fix minor langref typos
2022-09-24 18:42:00 +00:00
{#link|error sets|Error Set Type#} has fields which are guaranteed to be in the same
langref: correct info about type info of declarations
2022-02-14 19:26:55 +00:00
order as appearance in the source file.
</p>
<p>
Type information of {#link|structs|struct#}, {#link|unions|union#}, {#link|enums|enum#}, and
{#link|opaques|opaque#} has declarations, which are also guaranteed to be in the same
order as appearance in the source file.
docs: update `@typeInfo` definition and clarify field order
2019-04-05 16:37:49 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|@typeName#}
typeName: amend return type to string literal This was already the case, but the documentation failed to point out that the returned value is of type `*const [N:0]u8`, i.e. that of a string literal. Also adds a behavioral test to assert that this is the case.
2021-04-28 00:13:47 +00:00
<pre>{#syntax#}@typeName(T: type) *const [N:0]u8{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
backport copy elision changes This commit contains everything from the copy-elision-2 branch that does not have to do with copy elision directly, but is generally useful for master branch. * All const values know their parents, when applicable, not just structs and unions. * Null pointers in const values are represented explicitly, rather than as a HardCodedAddr value of 0. * Rename "maybe" to "optional" in various code locations. * Separate DeclVarSrc and DeclVarGen * Separate PtrCastSrc and PtrCastGen * Separate CmpxchgSrc and CmpxchgGen * Represent optional error set as an integer, using the 0 value. In a const value, it uses nullptr. * Introduce type_has_one_possible_value and use it where applicable. * Fix debug builds not setting memory to 0xaa when storing undefined. * Separate the type of a variable from the const value of a variable. * Use copy_const_val where appropriate. * Rearrange structs to pack data more efficiently. * Move test/cases/* to test/behavior/* * Use `std.debug.assertOrPanic` in behavior tests instead of `std.debug.assert`. * Fix outdated slice syntax in docs.
2019-01-30 02:47:26 +00:00
This function returns the string representation of a type, as
an array. It is equivalent to a string literal of the type name.
stage2: improve `@typeName` * make it always return a fully qualified name. stage1 is inconsistent about this. * AstGen: fix anon_name_strategy to correctly be `func` when anon type creation happens in the operand of the return expression. * Sema: implement type names for the "function" naming strategy. * Put "enum", "union", "opaque", or "struct" in place of "anon" when creating respective anonymous Decl names. * std.testing: add `expectStringStartsWith`. Didn't end up using it after all. Also this enables the real test runner for stage2 LLVM backend (sans wasm32) since it works now.
2022-03-18 07:12:22 +00:00
The returned type name is fully qualified with the parent namespace included
as part of the type name with a series of dots.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
Rename @typeOf to @TypeOf in the language reference
2019-12-09 20:59:42 +00:00
{#header_open|@TypeOf#}
update docs for `@TypeOf`
2020-03-04 23:05:14 +00:00
<pre>{#syntax#}@TypeOf(...) type{#endsyntax#}</pre>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
langref: update builtin variadic functions Documentation was outdated.
2024-10-03 11:37:36 +00:00
{#syntax#}@TypeOf{#endsyntax#} is a special builtin function that takes any (non-zero) number of expressions
update docs for `@TypeOf`
2020-03-04 23:05:14 +00:00
as parameters and returns the type of the result, using {#link|Peer Type Resolution#}.
</p>
<p>
The expressions are evaluated, however they are guaranteed to have no <em>runtime</em> side-effects:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_TypeOf_builtin.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
introduce vector type for SIMD See #903 * create with `@Vector(len, ElemType)` * only wrapping addition is implemented This feature is far from complete; this is only the beginning.
2019-01-31 04:36:52 +00:00
{#header_close#}
update `@unionInit` to integrate with result location semantics
2019-07-03 17:40:40 +00:00
{#header_open|@unionInit#}
<pre>{#syntax#}@unionInit(comptime Union: type, comptime active_field_name: []const u8, init_expr) Union{#endsyntax#}</pre>
<p>
This is the same thing as {#link|union#} initialization syntax, except that the field name is a
{#link|comptime#}-known value rather than an identifier token.
</p>
<p>
{#syntax#}@unionInit{#endsyntax#} forwards its {#link|result location|Result Location Semantics#} to {#syntax#}init_expr{#endsyntax#}.
</p>
{#header_close#}
basic language features do not belong in std.meta
2022-03-14 05:21:16 +00:00
{#header_open|@Vector#}
<pre>{#syntax#}@Vector(len: comptime_int, Element: type) type{#endsyntax#}</pre>
<p>Creates {#link|Vectors#}.</p>
{#header_close#}
split `@qualCast` into `@constCast` and `@volatileCast`
2023-02-13 14:19:17 +00:00
{#header_open|@volatileCast#}
<pre>{#syntax#}@volatileCast(value: anytype) DestType{#endsyntax#}</pre>
<p>
Remove {#syntax#}volatile{#endsyntax#} qualifier from a pointer.
</p>
{#header_close#}
new builtins: @workItemId, @workGroupId, @workGroupSize * @workItemId returns the index of the work item in a work group for a dimension. * @workGroupId returns the index of the work group in the kernel dispatch for a dimension. * @workGroupSize returns the size of the work group for a dimension. These builtins are mainly useful for GPU backends. They are currently only implemented for the AMDGCN LLVM backend.
2023-03-18 14:59:56 +00:00
{#header_open|@workGroupId#}
<pre>{#syntax#}@workGroupId(comptime dimension: u32) u32{#endsyntax#}</pre>
<p>
Returns the index of the work group in the current kernel invocation in dimension {#syntax#}dimension{#endsyntax#}.
</p>
{#header_close#}
{#header_open|@workGroupSize#}
<pre>{#syntax#}@workGroupSize(comptime dimension: u32) u32{#endsyntax#}</pre>
<p>
Returns the number of work items that a work group has in dimension {#syntax#}dimension{#endsyntax#}.
</p>
{#header_close#}
{#header_open|@workItemId#}
<pre>{#syntax#}@workItemId(comptime dimension: u32) u32{#endsyntax#}</pre>
<p>
Returns the index of the work item in the work group in dimension {#syntax#}dimension{#endsyntax#}. This function returns values between {#syntax#}0{#endsyntax#} (inclusive) and {#syntax#}@workGroupSize(dimension){#endsyntax#} (exclusive).
</p>
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: fix alphabetical sorting of builtin functions
2018-12-15 01:21:23 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Build Mode#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
Zig has four build modes:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<ul>
docgen: verify internal links
2018-01-23 04:06:07 +00:00
<li>{#link|Debug#} (default)</li>
<li>{#link|ReleaseFast#}</li>
<li>{#link|ReleaseSafe#}</li>
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
<li>{#link|ReleaseSmall#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
<p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
To add standard build options to a <code class="file">build.zig</code> file:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|build.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
This causes these options to be available:
</p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<dl>
fix doc Build Mode
2023-03-04 09:10:07 +00:00
<dt><kbd>-Doptimize=Debug</kbd></dt><dd>Optimizations off and safety on (default)</dd>
<dt><kbd>-Doptimize=ReleaseSafe</kbd></dt><dd>Optimizations on and safety on</dd>
<dt><kbd>-Doptimize=ReleaseFast</kbd></dt><dd>Optimizations on and safety off</dd>
<dt><kbd>-Doptimize=ReleaseSmall</kbd></dt><dd>Size optimizations on and safety off</dd>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</dl>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Debug#}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
{#shell_samp#}$ zig build-exe example.zig{#end_shell_samp#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
<li>Fast compilation speed</li>
<li>Safety checks enabled</li>
<li>Slow runtime performance</li>
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
<li>Large binary size</li>
doc: add note about reproducible builds
2018-09-22 14:22:01 +00:00
<li>No reproducible build requirement</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|ReleaseFast#}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
{#shell_samp#}$ zig build-exe example.zig -O ReleaseFast{#end_shell_samp#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
<li>Fast runtime performance</li>
<li>Safety checks disabled</li>
<li>Slow compilation speed</li>
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
<li>Large binary size</li>
doc: add note about reproducible builds
2018-09-22 14:22:01 +00:00
<li>Reproducible build</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|ReleaseSafe#}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
{#shell_samp#}$ zig build-exe example.zig -O ReleaseSafe{#end_shell_samp#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
<li>Medium runtime performance</li>
<li>Safety checks enabled</li>
<li>Slow compilation speed</li>
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
<li>Large binary size</li>
doc: add note about reproducible builds
2018-09-22 14:22:01 +00:00
<li>Reproducible build</li>
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
</ul>
{#header_close#}
{#header_open|ReleaseSmall#}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
{#shell_samp#}$ zig build-exe example.zig -O ReleaseSmall{#end_shell_samp#}
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
<ul>
<li>Medium runtime performance</li>
<li>Safety checks disabled</li>
<li>Slow compilation speed</li>
<li>Small binary size</li>
doc: add note about reproducible builds
2018-09-22 14:22:01 +00:00
<li>Reproducible build</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
langref: docs for error return traces See #367
2018-06-14 22:12:05 +00:00
{#see_also|Compile Variables|Zig Build System|Undefined Behavior#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
introduce --single-threaded build option closes #1764 This adds another boolean to the test matrix; hopefully it does not inflate the time too much. std.event.Loop does not work with this option yet. See #1908
2019-02-01 22:49:29 +00:00
{#header_open|Single Threaded Builds#}
langref, tools: rename --single-threaded to -fsingle-threaded Commit 40f5e5dfc60e ("CLI: introduce -fsingle-threaded/ -fno-single-threaded", 2021-12-01) removed the `--single-threaded` option, but didn't update all mentions of it. $ zig version 0.11.0-dev.1568+c9b957c93 $ zig build-exe --help | grep single -fsingle-threaded Code assumes there is only one thread -fno-single-threaded Code may not assume there is only one thread $ zig build-exe --single-threaded foo.zig error: unrecognized parameter: '--single-threaded'
2023-02-04 18:08:01 +00:00
<p>Zig has a compile option <kbd>-fsingle-threaded</kbd> which has the following effects:</p>
introduce --single-threaded build option closes #1764 This adds another boolean to the test matrix; hopefully it does not inflate the time too much. std.event.Loop does not work with this option yet. See #1908
2019-02-01 22:49:29 +00:00
<ul>
Docs clarification: local static variable (#8381)
2021-06-23 05:45:36 +00:00
<li>All {#link|Thread Local Variables#} are treated as regular {#link|Container Level Variables#}.</li>
avoid the word "coroutine", they're "async functions"
2019-08-13 18:14:19 +00:00
<li>The overhead of {#link|Async Functions#} becomes equivalent to function call overhead.</li>
introduce --single-threaded build option closes #1764 This adds another boolean to the test matrix; hopefully it does not inflate the time too much. std.event.Loop does not work with this option yet. See #1908
2019-02-01 22:49:29 +00:00
<li>The {#syntax#}@import("builtin").single_threaded{#endsyntax#} becomes {#syntax#}true{#endsyntax#}
and therefore various userland APIs which read this variable become more efficient.
For example {#syntax#}std.Mutex{#endsyntax#} becomes
an empty data structure and all of its functions become no-ops.</li>
</ul>
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Undefined Behavior#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Zig has many instances of undefined behavior. If undefined behavior is
remove error set casting syntax. add `@errSetCast` See #1061
2018-06-18 19:01:42 +00:00
detected at compile-time, Zig emits a compile error and refuses to continue.
Most undefined behavior that cannot be detected at compile-time can be detected
at runtime. In these cases, Zig has safety checks. Safety checks can be disabled
docs: mention release-small along with release-fast
2019-09-26 16:05:49 +00:00
on a per-block basis with {#link|@setRuntimeSafety#}. The {#link|ReleaseFast#}
and {#link|ReleaseSmall#} build modes disable all safety checks (except where overridden
by {#link|@setRuntimeSafety#}) in order to facilitate optimizations.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<p>
When a safety check fails, Zig crashes with a stack trace, like this:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_undefined_behavior.zig#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Reaching Unreachable Code#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_reaching_unreachable.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_reaching_unreachable.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Index out of Bounds#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_index_out_of_bounds.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_index_out_of_bounds.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Cast Negative Number to Unsigned Integer#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_invalid_cast.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_invalid_cast.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
remove @minValue,@maxValue; add std.math.minInt,maxInt closes #1466 closes #1476
2018-10-26 18:59:58 +00:00
To obtain the maximum value of an unsigned integer, use {#syntax#}std.math.maxInt{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Cast Truncates Data#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_invalid_cast_truncate.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_invalid_cast_truncate.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
To truncate bits, use {#link|@truncate#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Integer Overflow#}
{#header_open|Default Operations#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>The following operators can cause integer overflow:</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>{#syntax#}+{#endsyntax#} (addition)</li>
<li>{#syntax#}-{#endsyntax#} (subtraction)</li>
<li>{#syntax#}-{#endsyntax#} (negation)</li>
<li>{#syntax#}*{#endsyntax#} (multiplication)</li>
<li>{#syntax#}/{#endsyntax#} (division)</li>
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<li>{#link|@divTrunc#} (division)</li>
<li>{#link|@divFloor#} (division)</li>
<li>{#link|@divExact#} (division)</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
<p>Example with addition at compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_overflow.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_overflow.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Standard Library Math Functions#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>These functions provided by the standard library return possible errors.</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>{#syntax#}@import("std").math.add{#endsyntax#}</li>
<li>{#syntax#}@import("std").math.sub{#endsyntax#}</li>
<li>{#syntax#}@import("std").math.mul{#endsyntax#}</li>
<li>{#syntax#}@import("std").math.divTrunc{#endsyntax#}</li>
<li>{#syntax#}@import("std").math.divFloor{#endsyntax#}</li>
<li>{#syntax#}@import("std").math.divExact{#endsyntax#}</li>
<li>{#syntax#}@import("std").math.shl{#endsyntax#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
<p>Example of catching an overflow for addition:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|math_add.zig#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Builtin Overflow Functions#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Resolve docs inconsistency with Overflow builtins In 41 (Undefined Behavior) . 5 (Integer Overflow) . 3 (Builtin Overflow Functions), it is stated that > These builtins return a bool of whether or not overflow occurred, as well as returning the overflowed bits: > * @addWithOverflow > * @subWithOverflow > * @mulWithOverflow > * @shlWithOverflow but in their definition says that it returns a `tuple`/`struct`. Example; `@addWithOverflow(a: anytype, b: anytype) struct { @TypeOf(a, b), u1 }` Co-authored-by: zooster <r00ster91@proton.me>
2023-03-13 14:47:20 +00:00
These builtins return a tuple containing whether there was an overflow
(as a {#syntax#}u1{#endsyntax#}) and the possibly overflowed bits of the operation:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<ul>
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<li>{#link|@addWithOverflow#}</li>
<li>{#link|@subWithOverflow#}</li>
<li>{#link|@mulWithOverflow#}</li>
<li>{#link|@shlWithOverflow#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
<p>
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
Example of {#link|@addWithOverflow#}:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|addWithOverflow_builtin.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Wrapping Operations#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
These operations have guaranteed wraparound semantics.
</p>
<ul>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>{#syntax#}+%{#endsyntax#} (wraparound addition)</li>
<li>{#syntax#}-%{#endsyntax#} (wraparound subtraction)</li>
<li>{#syntax#}-%{#endsyntax#} (wraparound negation)</li>
<li>{#syntax#}*%{#endsyntax#} (wraparound multiplication)</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_wraparound_semantics.zig#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_close#}
{#header_open|Exact Left Shift Overflow#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_shlExact_overwlow.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_shlExact_overflow.zig#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Exact Right Shift Overflow#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_shrExact_overflow.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_shrExact_overflow.zig#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Division by Zero#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_division_by_zero.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_division_by_zero.zig#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Remainder Division by Zero#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_remainder_division_by_zero.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_remainder_division_by_zero.zig#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Exact Division Remainder#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_divExact_remainder.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_divExact_remainder.zig#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Attempt to Unwrap Null#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_unwrap_null.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_unwrap_null.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>One way to avoid this crash is to test for null instead of assuming non-null, with
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
the {#syntax#}if{#endsyntax#} expression:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|testing_null_with_if.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
{#see_also|Optionals#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Attempt to Unwrap Error#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_unwrap_error.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_unwrap_error.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>One way to avoid this crash is to test for an error instead of assuming a successful result, with
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
the {#syntax#}if{#endsyntax#} expression:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|testing_error_with_if.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
{#see_also|Errors#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Invalid Error Code#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_invalid_error_code.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_invalid_error_code.zig#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Invalid Enum Cast#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_invalid_enum_cast.zig#}
add runtime safety for `@intToEnum`; add docs for runtime safety See #367
2018-07-02 19:49:49 +00:00
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
<p>At runtime:</p>
{#code|runtime_invalid_enum_cast.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
remove error set casting syntax. add `@errSetCast` See #1061
2018-06-18 19:01:42 +00:00
{#header_open|Invalid Error Set Cast#}
langref: docs for invalid error set cast and incorrect pointer alignment also add detection of incorrect pointer alignment at compile-time of pointers that were constructed with `@intToPtr`.
2018-07-09 15:13:29 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_invalid_error_set_cast.zig#}
langref: docs for invalid error set cast and incorrect pointer alignment also add detection of incorrect pointer alignment at compile-time of pointers that were constructed with `@intToPtr`.
2018-07-09 15:13:29 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_invalid_error_set_cast.zig#}
langref: docs for union safety
2018-07-10 14:37:58 +00:00
remove error set casting syntax. add `@errSetCast` See #1061
2018-06-18 19:01:42 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Incorrect Pointer Alignment#}
langref: docs for invalid error set cast and incorrect pointer alignment also add detection of incorrect pointer alignment at compile-time of pointers that were constructed with `@intToPtr`.
2018-07-09 15:13:29 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_incorrect_pointer_alignment.zig#}
langref: docs for invalid error set cast and incorrect pointer alignment also add detection of incorrect pointer alignment at compile-time of pointers that were constructed with `@intToPtr`.
2018-07-09 15:13:29 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_incorrect_pointer_alignment.zig#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Wrong Union Field Access#}
langref: docs for union safety
2018-07-10 14:37:58 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_wrong_union_field_access.zig#}
langref: docs for union safety
2018-07-10 14:37:58 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_wrong_union_field_access.zig#}
langref: docs for union safety
2018-07-10 14:37:58 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
This safety is not available for {#syntax#}extern{#endsyntax#} or {#syntax#}packed{#endsyntax#} unions.
langref: docs for union safety
2018-07-10 14:37:58 +00:00
</p>
<p>
To change the active field of a union, assign the entire union, like this:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|change_active_union_field.zig#}
langref: docs for union safety
2018-07-10 14:37:58 +00:00
<p>
To change the active field of a union when a meaningful value for the field is not known,
use {#link|undefined#}, like this:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|undefined_active_union_field.zig#}
langref: docs for union safety
2018-07-10 14:37:58 +00:00
improve docs for unions and switching on tagged unions closes #1943
2019-02-27 03:46:35 +00:00
{#see_also|union|extern union#}
`@floatToInt` now has safety-checked undefined behavior when the integer part does not fit in the destination integer type * Also fix incorrect safety triggered for integer casting an `i32` to a `u7`. closes #1138 * adds compiler-rt function: `__floatuntidf`
2018-06-19 20:06:10 +00:00
{#header_close#}
add documentation placeholders for unions
2017-11-17 03:13:20 +00:00
add docs for C pointers
2019-02-14 23:59:20 +00:00
{#header_open|Out of Bounds Float to Integer Cast#}
langref: document out of bounds float to integer cast
2023-07-21 13:17:58 +00:00
<p>
This happens when casting a float to an integer where the float has a value outside the
integer type's range.
</p>
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_out_of_bounds_float_to_integer_cast.zig#}
langref: document out of bounds float to integer cast
2023-07-21 13:17:58 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_out_of_bounds_float_to_integer_cast.zig#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
remove error set casting syntax. add `@errSetCast` See #1061
2018-06-18 19:01:42 +00:00
add docs for C pointers
2019-02-14 23:59:20 +00:00
{#header_open|Pointer Cast Invalid Null#}
implement allowzero pointer attribute closes #1953 only needed for freestanding targets. also adds safety for `@intToPtr` when the address is zero.
2019-03-25 16:55:45 +00:00
<p>
This happens when casting a pointer with the address 0 to a pointer which may not have the address 0.
For example, {#link|C Pointers#}, {#link|Optional Pointers#}, and {#link|allowzero#} pointers
allow address zero, but normal {#link|Pointers#} do not.
</p>
add docs for C pointers
2019-02-14 23:59:20 +00:00
<p>At compile-time:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_comptime_invalid_null_pointer_cast.zig#}
add docs for C pointers
2019-02-14 23:59:20 +00:00
<p>At runtime:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|runtime_invalid_null_pointer_cast.zig#}
add docs for C pointers
2019-02-14 23:59:20 +00:00
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Memory#}
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
<p>
The Zig language performs no memory management on behalf of the programmer. This is
why Zig has no runtime, and why Zig code works seamlessly in so many environments,
including real-time software, operating system kernels, embedded devices, and
low latency servers. As a consequence, Zig programmers must always be able to answer
the question:
</p>
<p>{#link|Where are the bytes?#}</p>
<p>
Like Zig, the C programming language has manual memory management. However, unlike Zig,
C has a default allocator - <code>malloc</code>, <code>realloc</code>, and <code>free</code>.
When linking against libc, Zig exposes this allocator with {#syntax#}std.heap.c_allocator{#endsyntax#}.
However, by convention, there is no default allocator in Zig. Instead, functions which need to
allocgate: stage 1 and 2 building
2021-10-29 01:03:15 +00:00
allocate accept an {#syntax#}Allocator{#endsyntax#} parameter. Likewise, data structures such as
{#syntax#}std.ArrayList{#endsyntax#} accept an {#syntax#}Allocator{#endsyntax#} parameter in
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
their initialization functions:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_allocator.zig#}
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
<p>
In the above example, 100 bytes of stack memory are used to initialize a
{#syntax#}FixedBufferAllocator{#endsyntax#}, which is then passed to a function.
As a convenience there is a global {#syntax#}FixedBufferAllocator{#endsyntax#}
Update docs to reflect new testing.allocator usage
2020-01-30 03:39:08 +00:00
available for quick tests at {#syntax#}std.testing.allocator{#endsyntax#},
Fix minor langref typos
2022-09-24 18:42:00 +00:00
which will also perform basic leak detection.
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
</p>
<p>
docs: Fix reference to General Purpose Allocator
2020-08-12 08:56:34 +00:00
Zig has a general purpose allocator available to be imported
with {#syntax#}std.heap.GeneralPurposeAllocator{#endsyntax#}. However, it is still recommended to
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
follow the {#link|Choosing an Allocator#} guide.
</p>
{#header_open|Choosing an Allocator#}
<p>What allocator to use depends on a number of factors. Here is a flow chart to help you decide:
</p>
<ol>
<li>
allocgate: stage 1 and 2 building
2021-10-29 01:03:15 +00:00
Are you making a library? In this case, best to accept an {#syntax#}Allocator{#endsyntax#}
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
as a parameter and allow your library's users to decide what allocator to use.
</li>
<li>Are you linking libc? In this case, {#syntax#}std.heap.c_allocator{#endsyntax#} is likely
the right choice, at least for your main allocator.</li>
Remove old deprecated symbols in std (#21584) Also, actually run tests inside std/tar/writer.zig
2024-10-04 20:50:25 +00:00
<li>
Need to use the same allocator in multiple threads? Use one of your choice
wrapped around {#syntax#}std.heap.ThreadSafeAllocator{#endsyntax#}
</li>
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
<li>
Is the maximum number of bytes that you will need bounded by a number known at
Remove old deprecated symbols in std (#21584) Also, actually run tests inside std/tar/writer.zig
2024-10-04 20:50:25 +00:00
{#link|comptime#}? In this case, use {#syntax#}std.heap.FixedBufferAllocator{#endsyntax#}.
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
</li>
<li>
Is your program a command line application which runs from start to end without any fundamental
cyclical pattern (such as a video game main loop, or a web server request handler),
such that it would make sense to free everything at once at the end?
In this case, it is recommended to follow this pattern:
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|cli_allocation.zig#}
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
When using this kind of allocator, there is no need to free anything manually. Everything
gets freed at once with the call to {#syntax#}arena.deinit(){#endsyntax#}.
</li>
<li>
Are the allocations part of a cyclical pattern such as a video game main loop, or a web
server request handler? If the allocations can all be freed at once, at the end of the cycle,
for example once the video game frame has been fully rendered, or the web server request has
been served, then {#syntax#}std.heap.ArenaAllocator{#endsyntax#} is a great candidate. As
demonstrated in the previous bullet point, this allows you to free entire arenas at once.
Note also that if an upper bound of memory can be established, then
{#syntax#}std.heap.FixedBufferAllocator{#endsyntax#} can be used as a further optimization.
</li>
<li>
Are you writing a test, and you want to make sure {#syntax#}error.OutOfMemory{#endsyntax#}
Update docs to reflect new testing.allocator usage
2020-01-30 03:39:08 +00:00
is handled correctly? In this case, use {#syntax#}std.testing.FailingAllocator{#endsyntax#}.
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
</li>
<li>
update langref in light of new general purpose allocator
2020-08-08 09:15:34 +00:00
Are you writing a test? In this case, use {#syntax#}std.testing.allocator{#endsyntax#}.
</li>
<li>
Finally, if none of the above apply, you need a general purpose allocator.
Zig's general purpose allocator is available as a function that takes a {#link|comptime#}
{#link|struct#} of configuration options and returns a type.
std lib general purpose allocator: disable stack tracing on mips Sadly, trying to collect stack frames goes into an infinite loop on mips. This sets the default number of stack frames to collect to 0 on mips.
2020-08-08 09:15:46 +00:00
Generally, you will set up one {#syntax#}std.heap.GeneralPurposeAllocator{#endsyntax#} in
update langref in light of new general purpose allocator
2020-08-08 09:15:34 +00:00
your main function, and then pass it or sub-allocators around to various parts of your
application.
</li>
<li>
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
You can also consider {#link|Implementing an Allocator#}.
</li>
</ol>
{#header_close#}
{#header_open|Where are the bytes?#}
langref: fix incorrect reference to string literal
2023-12-05 00:40:07 +00:00
<p>String literals such as {#syntax#}"hello"{#endsyntax#} are in the global constant data section.
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
This is why it is an error to pass a string literal to a mutable slice, like this:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_string_literal_to_slice.zig#}
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
<p>However if you make the slice constant, then it works:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_string_literal_to_const_slice.zig#}
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
<p>
Fix backticked code in langref
2020-11-03 17:37:28 +00:00
Just like string literals, {#syntax#}const{#endsyntax#} declarations, when the value is known at {#link|comptime#},
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
are stored in the global constant data section. Also {#link|Compile Time Variables#} are stored
in the global constant data section.
</p>
<p>
Fix backticked code in langref
2020-11-03 17:37:28 +00:00
{#syntax#}var{#endsyntax#} declarations inside functions are stored in the function's stack frame. Once a function returns,
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
any {#link|Pointers#} to variables in the function's stack frame become invalid references, and
dereferencing them becomes unchecked {#link|Undefined Behavior#}.
</p>
<p>
Fix backticked code in langref
2020-11-03 17:37:28 +00:00
{#syntax#}var{#endsyntax#} declarations at the top level or in {#link|struct#} declarations are stored in the global
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
data section.
</p>
<p>
The location of memory allocated with {#syntax#}allocator.alloc{#endsyntax#} or
{#syntax#}allocator.create{#endsyntax#} is determined by the allocator's implementation.
</p>
docs: add html lang and minor fixes
2019-12-05 21:38:59 +00:00
<p>TODO: thread local variables</p>
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
{#header_close#}
{#header_open|Implementing an Allocator#}
<p>Zig programmers can implement their own allocators by fulfilling the Allocator interface.
In order to do this one must read carefully the documentation comments in std/mem.zig and
allocgate: apply missed changes
2021-10-31 21:45:27 +00:00
then supply a {#syntax#}allocFn{#endsyntax#} and a {#syntax#}resizeFn{#endsyntax#}.
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
</p>
<p>
There are many example allocators to look at for inspiration. Look at std/heap.zig and
Link to the GPA now that it's on upstream
2021-07-03 23:00:32 +00:00
{#syntax#}std.heap.GeneralPurposeAllocator{#endsyntax#}.
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
</p>
{#header_close#}
{#header_open|Heap Allocation Failure#}
<p>
Many programming languages choose to handle the possibility of heap allocation failure by
unconditionally crashing. By convention, Zig programmers do not consider this to be a
satisfactory solution. Instead, {#syntax#}error.OutOfMemory{#endsyntax#} represents
heap allocation failure, and Zig libraries return this error code whenever heap allocation
failure prevented an operation from completing successfully.
</p>
<p>
Some have argued that because some operating systems such as Linux have memory overcommit enabled by
default, it is pointless to handle heap allocation failure. There are many problems with this reasoning:
</p>
<ul>
<li>Only some operating systems have an overcommit feature.
<ul>
<li>Linux has it enabled by default, but it is configurable.</li>
<li>Windows does not overcommit.</li>
<li>Embedded systems do not have overcommit.</li>
<li>Hobby operating systems may or may not have overcommit.</li>
</ul>
</li>
<li>
For real-time systems, not only is there no overcommit, but typically the maximum amount
of memory per application is determined ahead of time.
</li>
<li>
When writing a library, one of the main goals is code reuse. By making code handle
allocation failure correctly, a library becomes eligible to be reused in
more contexts.
</li>
<li>
Although some software has grown to depend on overcommit being enabled, its existence
is the source of countless user experience disasters. When a system with overcommit enabled,
such as Linux on default settings, comes close to memory exhaustion, the system locks up
and becomes unusable. At this point, the OOM Killer selects an application to kill
based on heuristics. This non-deterministic decision often results in an important process
being killed, and often fails to return the system back to working order.
</li>
</ul>
{#header_close#}
{#header_open|Recursion#}
<p>
Recursion is a fundamental tool in modeling software. However it has an often-overlooked problem:
unbounded memory allocation.
</p>
<p>
Recursion is an area of active experimentation in Zig and so the documentation here is not final.
You can read a
<a href="https://ziglang.org/download/0.3.0/release-notes.html#recursion">summary of recursion status in the 0.3.0 release notes</a>.
</p>
<p>
The short summary is that currently recursion works normally as you would expect. Although Zig code
is not yet protected from stack overflow, it is planned that a future version of Zig will provide
such protection, with some degree of cooperation from Zig code required.
</p>
{#header_close#}
{#header_open|Lifetime and Ownership#}
<p>
It is the Zig programmer's responsibility to ensure that a {#link|pointer|Pointers#} is not
accessed when the memory pointed to is no longer available. Note that a {#link|slice|Slices#}
is a form of pointer, in that it references other memory.
</p>
<p>
In order to prevent bugs, there are some helpful conventions to follow when dealing with pointers.
In general, when a function returns a pointer, the documentation for the function should explain
who "owns" the pointer. This concept helps the programmer decide when it is appropriate, if ever,
to free the pointer.
</p>
<p>
For example, the function's documentation may say "caller owns the returned memory", in which case
the code that calls the function must have a plan for when to free that memory. Probably in this situation,
allocgate: stage 1 and 2 building
2021-10-29 01:03:15 +00:00
the function will accept an {#syntax#}Allocator{#endsyntax#} parameter.
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
</p>
<p>
docs: fix mention of deprecated ArrayList.span()
2020-06-12 15:58:43 +00:00
Sometimes the lifetime of a pointer may be more complicated. For example, the
{#syntax#}std.ArrayList(T).items{#endsyntax#} slice has a lifetime that remains
add documentation for Memory closes #1904
2019-03-19 01:40:24 +00:00
valid until the next time the list is resized, such as by appending new elements.
</p>
<p>
The API documentation for functions and data structures should take great care to explain
the ownership and lifetime semantics of pointers. Ownership determines whose responsibility it
is to free the memory referenced by the pointer, and lifetime determines the point at which
the memory becomes inaccessible (lest {#link|Undefined Behavior#} occur).
</p>
{#header_close#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Compile Variables#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Compile variables are accessible by importing the {#syntax#}"builtin"{#endsyntax#} package,
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
which the compiler makes available to every Zig source file. It contains
compile-time constants such as the current target, endianness, and release mode.
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|compile_variables.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Example of what is imported with {#syntax#}@import("builtin"){#endsyntax#}:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
langref: automatic update of builtin.zig now the docs can't get out of date for this See #367
2018-06-07 23:10:45 +00:00
{#builtin#}
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|Build Mode#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Root Source File#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>TODO: explain how root source file finds other files</p>
<p>TODO: pub fn main</p>
<p>TODO: pub fn panic</p>
<p>TODO: if linking with libc you can use export fn main</p>
<p>TODO: order independent top level declarations</p>
<p>TODO: lazy analysis</p>
<p>TODO: using comptime { _ = @import() }</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
langref cleanups * move the opaque section to after struct, enum, union, and add hyperlinks * improve the introduction of the zig build system. don't link to the wiki. * update to the latest zig init-exe example code * rename headers to avoid redundant words such as "zig" * simplify example code
2020-10-17 04:29:33 +00:00
{#header_open|Zig Build System#}
<p>
The Zig Build System provides a cross-platform, dependency-free way to declare
the logic required to build a project. With this system, the logic to build
a project is written in a build.zig file, using the Zig Build System API to
declare and configure build artifacts and other tasks.
</p>
<p>
Some examples of tasks the build system can help with:
</p>
<ul>
langref: update Zig Build System section It's hosted externally for now. closes #18103
2024-01-19 04:14:44 +00:00
<li>Performing tasks in parallel and caching the results.</li>
<li>Depending on other projects.</li>
<li>Providing a package for other projects to depend on.</li>
langref cleanups * move the opaque section to after struct, enum, union, and add hyperlinks * improve the introduction of the zig build system. don't link to the wiki. * update to the latest zig init-exe example code * rename headers to avoid redundant words such as "zig" * simplify example code
2020-10-17 04:29:33 +00:00
<li>Creating build artifacts by executing the Zig compiler. This includes
building Zig source code as well as C and C++ source code.</li>
<li>Capturing user-configured options and using those options to configure
the build.</li>
<li>Surfacing build configuration as {#link|comptime#} values by providing a
file that can be {#link|imported|@import#} by Zig code.</li>
<li>Caching build artifacts to avoid unnecessarily repeating steps.</li>
<li>Executing build artifacts or system-installed tools.</li>
<li>Running tests and verifying the output of executing a build artifact matches
the expected value.</li>
<li>Running <code>zig fmt</code> on a codebase or a subset of it.</li>
<li>Custom tasks.</li>
</ul>
<p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
To use the build system, run <kbd>zig build --help</kbd>
langref cleanups * move the opaque section to after struct, enum, union, and add hyperlinks * improve the introduction of the zig build system. don't link to the wiki. * update to the latest zig init-exe example code * rename headers to avoid redundant words such as "zig" * simplify example code
2020-10-17 04:29:33 +00:00
to see a command-line usage help menu. This will include project-specific
options that were declared in the build.zig script.
</p>
langref: update Zig Build System section It's hosted externally for now. closes #18103
2024-01-19 04:14:44 +00:00
<p>
For the time being, the build system documentation is hosted externally:
<a href="https://ziglang.org/learn/build-system/">Build System Documentation</a>
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|C#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Although Zig is independent of C, and, unlike most other languages, does not depend on libc,
Zig acknowledges the importance of interacting with existing C code.
</p>
<p>
There are a few ways that Zig facilitates C interop.
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|C Type Primitives#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
These have guaranteed C ABI compatibility and can be used like any other type.
</p>
<ul>
langref: Add c_char to the list of primitive types
2023-06-28 18:58:45 +00:00
<li>{#syntax#}c_char{#endsyntax#}</li>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
<li>{#syntax#}c_short{#endsyntax#}</li>
<li>{#syntax#}c_ushort{#endsyntax#}</li>
<li>{#syntax#}c_int{#endsyntax#}</li>
<li>{#syntax#}c_uint{#endsyntax#}</li>
<li>{#syntax#}c_long{#endsyntax#}</li>
<li>{#syntax#}c_ulong{#endsyntax#}</li>
<li>{#syntax#}c_longlong{#endsyntax#}</li>
<li>{#syntax#}c_ulonglong{#endsyntax#}</li>
<li>{#syntax#}c_longdouble{#endsyntax#}</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
Langref: replace mentions of c_void with anyopaque
2021-12-21 13:13:32 +00:00
<p>
To interop with the C {#syntax#}void{#endsyntax#} type, use {#syntax#}anyopaque{#endsyntax#}.
</p>
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|Primitive Types#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Import from C Header File#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
The {#syntax#}@cImport{#endsyntax#} builtin function can be used
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
to directly import symbols from <code class="file">.h</code> files:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|cImport_builtin.zig#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
The {#syntax#}@cImport{#endsyntax#} function takes an expression as a parameter.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
This expression is evaluated at compile-time and is used to control
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
preprocessor directives and include multiple <code class="file">.h</code> files:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#syntax_block|zig|@cImport Expression#}
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
const builtin = @import("builtin");
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
const c = @cImport({
langref: small updates
2020-03-23 23:00:52 +00:00
@cDefine("NDEBUG", builtin.mode == .ReleaseFast);
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
if (something) {
@cDefine("_GNU_SOURCE", {});
}
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
@cInclude("stdlib.h");
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
if (something) {
@cUndef("_GNU_SOURCE");
}
@cInclude("soundio.h");
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
});
docgen: re-enable syntax checking for code blocks In a previous commit (f4d3d29), syntax checking for code blocks with the `syntax` type was disabled due to a change in astgen now checking the existence of identifiers. The change in astgen caused some code samples in the language reference to cause compilation errors. This commit updates the code samples in the language reference and re-enables syntax checking. Some code samples have been changed to unchecked syntax blocks using `{#syntax_block#}` when suitable.
2021-09-20 08:32:34 +00:00
{#end_syntax_block#}
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|@cImport|@cInclude|@cDefine|@cUndef|@import#}
langref: document exporting a library closes #1431
2018-08-27 21:44:58 +00:00
{#header_close#}
add docs for C pointers
2019-02-14 23:59:20 +00:00
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
{#header_open|C Translation CLI#}
langref: move paragraph inside the p element In the "C Translation CLI" section, move the paragraph inside the p element. The current HTML is valid, but, as an example, a paragraph outside a p element is not handled correctly by the browser Inspect tool.
2023-01-25 08:43:26 +00:00
<p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
Zig's C translation capability is available as a CLI tool via <kbd>zig translate-c</kbd>.
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
It requires a single filename as an argument. It may also take a set of optional flags that are
forwarded to clang. It writes the translated file to stdout.
langref: move paragraph inside the p element In the "C Translation CLI" section, move the paragraph inside the p element. The current HTML is valid, but, as an example, a paragraph outside a p element is not handled correctly by the browser Inspect tool.
2023-01-25 08:43:26 +00:00
</p>
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
{#header_open|Command line flags#}
<ul>
<li>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<kbd>-I</kbd>:
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
Specify a search directory for include files. May be used multiple times. Equivalent to
<a href="https://releases.llvm.org/12.0.0/tools/clang/docs/ClangCommandLineReference.html#cmdoption-clang-i-dir">
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
clang's <kbd>-I</kbd> flag</a>. The current directory is <em>not</em> included by default;
use <kbd>-I.</kbd> to include it.
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
</li>
<li>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<kbd>-D</kbd>: Define a preprocessor macro. Equivalent to
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
<a href="https://releases.llvm.org/12.0.0/tools/clang/docs/ClangCommandLineReference.html#cmdoption-clang-d-macro">
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
clang's <kbd>-D</kbd> flag</a>.
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
</li>
<li>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<kbd>-cflags [flags] --</kbd>: Pass arbitrary additional
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
<a href="https://releases.llvm.org/12.0.0/tools/clang/docs/ClangCommandLineReference.html">command line
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
flags</a> to clang. Note: the list of flags must end with <kbd>--</kbd>
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
</li>
<li>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<kbd>-target</kbd>: The {#link|target triple|Targets#} for the translated Zig code.
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
If no target is specified, the current host target will be used.
</li>
</ul>
{#header_close#}
{#header_open|Using -target and -cflags#}
<p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<strong>Important!</strong> When translating C code with <kbd>zig translate-c</kbd>,
you <strong>must</strong> use the same <kbd>-target</kbd> triple that you will use when compiling
the translated code. In addition, you <strong>must</strong> ensure that the <kbd>-cflags</kbd> used,
if any, match the cflags used by code on the target system. Using the incorrect <kbd>-target</kbd>
or <kbd>-cflags</kbd> could result in clang or Zig parse failures, or subtle ABI incompatibilities
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
when linking with C code.
</p>
langref: always start code on a separate line in a syntax_block In a syntax_block the code always start on a separate code, expect for C, JavaScript, Peg and with Zig inline assembly. Ensure that the code starts on a separate line, even in cases where there is only one line. Ensure that the end_syntax_block is always on a separate line and that the indentation is consistent.
2023-01-19 11:33:00 +00:00
{#syntax_block|c|varytarget.h#}
long FOO = __LONG_MAX__;
{#end_syntax_block#}
langref: remove HTML code from a shell node Several <em> elements where added inside a shell node in the Using--target-and--cflags section. Remove them, since they are not supposed to be handled by codegen. For the original commit, see 0c091feb5 (Improve HTML semantics and a11y of language reference). Fixes #13846
2022-12-09 19:52:01 +00:00
{#shell_samp#}$ zig translate-c -target thumb-freestanding-gnueabihf varytarget.h|grep FOO
pub export var FOO: c_long = 2147483647;
$ zig translate-c -target x86_64-macos-gnu varytarget.h|grep FOO
pub export var FOO: c_long = 9223372036854775807;{#end_shell_samp#}
langref: always start code on a separate line in a syntax_block In a syntax_block the code always start on a separate code, expect for C, JavaScript, Peg and with Zig inline assembly. Ensure that the code starts on a separate line, even in cases where there is only one line. Ensure that the end_syntax_block is always on a separate line and that the indentation is consistent.
2023-01-19 11:33:00 +00:00
{#syntax_block|c|varycflags.h#}
enum FOO { BAR };
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
int do_something(enum FOO foo);
{#end_syntax_block#}
{#shell_samp#}$ zig translate-c varycflags.h|grep -B1 do_something
langref: remove HTML code from a shell node Several <em> elements where added inside a shell node in the Using--target-and--cflags section. Remove them, since they are not supposed to be handled by codegen. For the original commit, see 0c091feb5 (Improve HTML semantics and a11y of language reference). Fixes #13846
2022-12-09 19:52:01 +00:00
pub const enum_FOO = c_uint;
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
pub extern fn do_something(foo: enum_FOO) c_int;
langref: remove HTML code from a shell node Several <em> elements where added inside a shell node in the Using--target-and--cflags section. Remove them, since they are not supposed to be handled by codegen. For the original commit, see 0c091feb5 (Improve HTML semantics and a11y of language reference). Fixes #13846
2022-12-09 19:52:01 +00:00
$ zig translate-c -cflags -fshort-enums -- varycflags.h|grep -B1 do_something
pub const enum_FOO = u8;
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
pub extern fn do_something(foo: enum_FOO) c_int;{#end_shell_samp#}
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
{#header_close#}
{#header_open|@cImport vs translate-c#}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<p>{#syntax#}@cImport{#endsyntax#} and <kbd>zig translate-c</kbd> use the same underlying
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
C translation functionality, so on a technical level they are equivalent. In practice,
{#syntax#}@cImport{#endsyntax#} is useful as a way to quickly and easily access numeric constants, typedefs,
and record types without needing any extra setup. If you need to pass {#link|cflags|Using -target and -cflags#}
to clang, or if you would like to edit the translated code, it is recommended to use
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<kbd>zig translate-c</kbd> and save the results to a file. Common reasons for editing
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
the generated code include: changing {#syntax#}anytype{#endsyntax#} parameters in function-like macros to more
specific types; changing {#syntax#}[*c]T{#endsyntax#} pointers to {#syntax#}[*]T{#endsyntax#} or
{#syntax#}*T{#endsyntax#} pointers for improved type safety; and
{#link|enabling or disabling runtime safety|@setRuntimeSafety#} within specific functions.
</p>
{#header_close#}
{#see_also|Targets|C Type Primitives|Pointers|C Pointers|Import from C Header File|@cInclude|@cImport|@setRuntimeSafety#}
{#header_close#}
{#header_open|C Translation Caching#}
<p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
The C translation feature (whether used via <kbd>zig translate-c</kbd> or
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
{#syntax#}@cImport{#endsyntax#}) integrates with the Zig caching system. Subsequent runs with
the same source file, target, and cflags will use the cache instead of repeatedly translating
the same code.
</p>
<p>
To see where the cached files are stored when compiling code that uses {#syntax#}@cImport{#endsyntax#},
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
use the <kbd>--verbose-cimport</kbd> flag:
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|verbose_cimport_flag.zig#}
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
<p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<code class="file">cimport.h</code> contains the file to translate (constructed from calls to
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
{#syntax#}@cInclude{#endsyntax#}, {#syntax#}@cDefine{#endsyntax#}, and {#syntax#}@cUndef{#endsyntax#}),
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<code class="file">cimport.h.d</code> is the list of file dependencies, and
<code class="file">cimport.zig</code> contains the translated output.
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
</p>
{#see_also|Import from C Header File|C Translation CLI|@cInclude|@cImport#}
{#header_close#}
{#header_open|Translation failures#}
<p>
Some C constructs cannot be translated to Zig - for example, <em>goto</em>,
structs with bitfields, and token-pasting macros. Zig employs <em>demotion</em> to allow translation
Spelling corrections (#9833) Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2021-09-24 17:39:20 +00:00
to continue in the face of non-translatable entities.
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
</p>
<p>
Demotion comes in three varieties - {#link|opaque#}, <em>extern</em>, and
{#syntax#}@compileError{#endsyntax#}.
C structs and unions that cannot be translated correctly will be translated as {#syntax#}opaque{}{#endsyntax#}.
Functions that contain opaque types or code constructs that cannot be translated will be demoted
to {#syntax#}extern{#endsyntax#} declarations.
Spelling corrections (#9833) Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2021-09-24 17:39:20 +00:00
Thus, non-translatable types can still be used as pointers, and non-translatable functions
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
can be called so long as the linker is aware of the compiled function.
</p>
<p>
{#syntax#}@compileError{#endsyntax#} is used when top-level definitions (global variables,
function prototypes, macros) cannot be translated or demoted. Since Zig uses lazy analysis for
Spelling corrections (#9833) Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2021-09-24 17:39:20 +00:00
top-level declarations, untranslatable entities will not cause a compile error in your code unless
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
you actually use them.
</p>
{#see_also|opaque|extern|@compileError#}
{#header_close#}
{#header_open|C Macros#}
<p>
C Translation makes a best-effort attempt to translate function-like macros into equivalent
Zig functions. Since C macros operate at the level of lexical tokens, not all C macros
Fix minor langref typos
2022-09-24 18:42:00 +00:00
can be translated to Zig. Macros that cannot be translated will be demoted to
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
{#syntax#}@compileError{#endsyntax#}. Note that C code which <em>uses</em> macros will be
translated without any additional issues (since Zig operates on the pre-processed source
Spelling corrections (#9833) Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2021-09-24 17:39:20 +00:00
with macros expanded). It is merely the macros themselves which may not be translatable to
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
Zig.
</p>
<p>Consider the following example:</p>
langref: always start code on a separate line in a syntax_block In a syntax_block the code always start on a separate code, expect for C, JavaScript, Peg and with Zig inline assembly. Ensure that the code starts on a separate line, even in cases where there is only one line. Ensure that the end_syntax_block is always on a separate line and that the indentation is consistent.
2023-01-19 11:33:00 +00:00
{#syntax_block|c|macro.c#}
#define MAKELOCAL(NAME, INIT) int NAME = INIT
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
int foo(void) {
MAKELOCAL(a, 1);
MAKELOCAL(b, 2);
return a + b;
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
}
{#end_syntax_block#}
{#shell_samp#}$ zig translate-c macro.c > macro.zig{#end_shell_samp#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|macro.zig#}
Spelling corrections (#9833) Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2021-09-24 17:39:20 +00:00
<p>Note that {#syntax#}foo{#endsyntax#} was translated correctly despite using a non-translatable
translate-c: Add documentation for `zig translate-c`
2021-06-27 09:25:32 +00:00
macro. {#syntax#}MAKELOCAL{#endsyntax#} was demoted to {#syntax#}@compileError{#endsyntax#} since
it cannot be expressed as a Zig function; this simply means that you cannot directly use
{#syntax#}MAKELOCAL{#endsyntax#} from Zig.
</p>
{#see_also|@compileError#}
{#header_close#}
add docs for C pointers
2019-02-14 23:59:20 +00:00
{#header_open|C Pointers#}
<p>
This type is to be avoided whenever possible. The only valid reason for using a C pointer is in
auto-generated code from translating C code.
</p>
<p>
When importing C header files, it is ambiguous whether pointers should be translated as
langref: Use "single-item pointer" and "many-item pointer" (#8217) These terms give short, descriptive names for the two pointer types which reflect the names used in src/type.zig.
2021-03-13 01:10:55 +00:00
single-item pointers ({#syntax#}*T{#endsyntax#}) or many-item pointers ({#syntax#}[*]T{#endsyntax#}).
add docs for C pointers
2019-02-14 23:59:20 +00:00
C pointers are a compromise so that Zig code can utilize translated header files directly.
</p>
<p>{#syntax#}[*c]T{#endsyntax#} - C pointer.</p>
<ul>
Improvements to docs and text * docs(std.math): elaborate on difference between absCast and absInt * docs(std.rand.Random.weightedIndex): elaborate on likelihood I think this makes it easier to understand. * langref: add small reminder * docs(std.fs.path.extension): brevity * docs(std.bit_set.StaticBitSet): mention the specific types * std.debug.TTY: explain what purpose this struct serves This should also make it clearer that this struct is not supposed to provide unrelated terminal manipulation functionality such as setting the cursor position or something because terminals are complicated and we should keep this struct simple and focused on debugging. * langref(package listing): brevity * langref: explain what exactly `threadlocal` causes to happen * std.array_list: link between swapRemove and orderedRemove Maybe this can serve as a TLDR and make it easier to decide. * PrefetchOptions.locality: clarify docs that this is a range This confused me previously and I thought I can only use either 0 or 3. * fix typos and more * std.builtin.CallingConvention: document some CCs * langref: explain possibly cryptic names I think it helps knowing what exactly these acronyms (@clz and @ctz) and abbreviations (@popCount) mean. * variadic function error: add missing preposition * std.fmt.format docs: nicely hyphenate * help menu: say what to optimize for I think this is slightly more specific than just calling it "optimizations". These are speed optimizations. I used the word "performance" here.
2023-04-23 18:06:21 +00:00
<li>Supports all the syntax of the other two pointer types ({#syntax#}*T{#endsyntax#}) and ({#syntax#}[*]T{#endsyntax#}).</li>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
<li>Coerces to other pointer types, as well as {#link|Optional Pointers#}.
When a C pointer is coerced to a non-optional pointer, safety-checked
add docs for C pointers
2019-02-14 23:59:20 +00:00
{#link|Undefined Behavior#} occurs if the address is 0.
</li>
<li>Allows address 0. On non-freestanding targets, dereferencing address 0 is safety-checked
docs for packed structs closes #1513
2019-02-22 15:56:49 +00:00
{#link|Undefined Behavior#}. Optional C pointers introduce another bit to keep track of
add docs for C pointers
2019-02-14 23:59:20 +00:00
null, just like {#syntax#}?usize{#endsyntax#}. Note that creating an optional C pointer
is unnecessary as one can use normal {#link|Optional Pointers#}.
</li>
fix regressed tests and update docs to use "type coercion"
2019-11-08 20:56:21 +00:00
<li>Supports {#link|Type Coercion#} to and from integers.</li>
add docs for C pointers
2019-02-14 23:59:20 +00:00
<li>Supports comparison with integers.</li>
<li>Does not support Zig-only pointer attributes such as alignment. Use normal {#link|Pointers#}
please!</li>
</ul>
Fix a typo.
2020-09-16 02:47:27 +00:00
<p>When a C pointer is pointing to a single struct (not an array), dereference the C pointer to
Fix minor langref typos
2022-09-24 18:42:00 +00:00
access the struct's fields or member data. That syntax looks like
added documentation for field access to C pointers (#3088)
2019-08-19 20:47:16 +00:00
this: </p>
<p>{#syntax#}ptr_to_struct.*.struct_member{#endsyntax#}</p>
<p>This is comparable to doing {#syntax#}->{#endsyntax#} in C.</p>
<p> When a C pointer is pointing to an array of structs, the syntax reverts to this:</p>
<p>{#syntax#}ptr_to_struct_array[index].struct_member{#endsyntax#}</p>
add docs for C pointers
2019-02-14 23:59:20 +00:00
{#header_close#}
langref: document extern variadic functions Add a new subsection within the C section, documenting extern variadic functions.
2022-12-12 10:32:48 +00:00
{#header_open|C Variadic Functions#}
<p>Zig supports extern variadic functions.</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_variadic_function.zig#}
langref: document extern variadic functions Add a new subsection within the C section, documenting extern variadic functions.
2022-12-12 10:32:48 +00:00
<p>
langref: add missing dot at the end of the paragraph In the "C Variadic Functions" section, add a missing dot at the end of the paragraph before the test_defining_variadic_function.zig example.
2023-01-25 15:58:50 +00:00
Variadic functions can be implemented using {#link|@cVaStart#}, {#link|@cVaEnd#}, {#link|@cVaArg#} and {#link|@cVaCopy#}.
langref: document extern variadic functions Add a new subsection within the C section, documenting extern variadic functions.
2022-12-12 10:32:48 +00:00
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|test_defining_variadic_function.zig#}
implement defining C variadic functions
2022-12-12 22:14:54 +00:00
langref: document extern variadic functions Add a new subsection within the C section, documenting extern variadic functions.
2022-12-12 10:32:48 +00:00
{#header_close#}
langref: document exporting a library closes #1431
2018-08-27 21:44:58 +00:00
{#header_open|Exporting a C Library#}
<p>
One of the primary use cases for Zig is exporting a library with the C ABI for other programming languages
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
to call into. The {#syntax#}export{#endsyntax#} keyword in front of functions, variables, and types causes them to
langref: document exporting a library closes #1431
2018-08-27 21:44:58 +00:00
be part of the library API:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|mathtest.zig#}
docs: update for shared libraries
2019-05-02 15:59:49 +00:00
<p>To make a static library:</p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
{#shell_samp#}$ zig build-lib mathtest.zig{#end_shell_samp#}
docs: update for shared libraries
2019-05-02 15:59:49 +00:00
<p>To make a shared library:</p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
{#shell_samp#}$ zig build-lib mathtest.zig -dynamic{#end_shell_samp#}
langref: document exporting a library closes #1431
2018-08-27 21:44:58 +00:00
<p>Here is an example with the {#link|Zig Build System#}:</p>
langref: always start code on a separate line in a syntax_block In a syntax_block the code always start on a separate code, expect for C, JavaScript, Peg and with Zig inline assembly. Ensure that the code starts on a separate line, even in cases where there is only one line. Ensure that the end_syntax_block is always on a separate line and that the indentation is consistent.
2023-01-19 11:33:00 +00:00
{#syntax_block|c|test.c#}
// This header is generated by zig from mathtest.zig
langref: document exporting a library closes #1431
2018-08-27 21:44:58 +00:00
#include "mathtest.h"
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
#include <stdio.h>
langref: document exporting a library closes #1431
2018-08-27 21:44:58 +00:00
int main(int argc, char **argv) {
docs: update for shared libraries
2019-05-02 15:59:49 +00:00
int32_t result = add(42, 1337);
printf("%d\n", result);
langref: document exporting a library closes #1431
2018-08-27 21:44:58 +00:00
return 0;
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
}
{#end_syntax_block#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|build_c.zig#}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
{#shell_samp#}$ zig build test
1379{#end_shell_samp#}
add documentation for @"" syntax closes #1614
2019-03-13 15:54:56 +00:00
{#see_also|export#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Mixing Object Files#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
You can mix Zig object files with any other object files that respect the C ABI. Example:
</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|base64.zig#}
langref: always start code on a separate line in a syntax_block In a syntax_block the code always start on a separate code, expect for C, JavaScript, Peg and with Zig inline assembly. Ensure that the code starts on a separate line, even in cases where there is only one line. Ensure that the end_syntax_block is always on a separate line and that the indentation is consistent.
2023-01-19 11:33:00 +00:00
{#syntax_block|c|test.c#}
// This header is generated by zig from base64.zig
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
#include "base64.h"
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
#include <string.h>
#include <stdio.h>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
int main(int argc, char **argv) {
const char *encoded = "YWxsIHlvdXIgYmFzZSBhcmUgYmVsb25nIHRvIHVz";
char buf[200];
size_t len = decode_base_64(buf, 200, encoded, strlen(encoded));
buf[len] = 0;
puts(buf);
return 0;
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
}
{#end_syntax_block#}
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|build_object.zig#}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
{#shell_samp#}$ zig build
Doc: zig-cache/bin -> zig-out/bin (#8659)
2021-04-30 22:41:59 +00:00
$ ./zig-out/bin/test
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
all your base are belong to us{#end_shell_samp#}
docgen: validate See Also sections See #465
2018-01-17 05:22:33 +00:00
{#see_also|Targets|Zig Build System#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_close#}
docgen: support wasm and wasi
2019-05-01 22:48:26 +00:00
{#header_open|WebAssembly#}
docs: update references to wasm_allocator
2019-11-26 00:30:41 +00:00
<p>Zig supports building for WebAssembly out of the box.</p>
docgen: support wasm and wasi
2019-05-01 22:48:26 +00:00
{#header_open|Freestanding#}
docs: update WebAssembly freestanding example
2023-11-01 14:56:30 +00:00
<p>For host environments like the web browser and nodejs, build as an executable using the freestanding
wasm: build static archive unless -dynamic specified This matches the behaviour for other targets in that ``` zig build-lib math.zig -target wasm32-freestanding ``` produces now `libmath.a` while ``` zig build-lib math.zig -dynamic -target wasm32-freestanding ``` is required to create a loadable Wasm module.
2021-05-21 18:24:13 +00:00
OS target. Here's an example of running Zig code compiled to WebAssembly with nodejs.</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|math.zig#}
langref: always start code on a separate line in a syntax_block In a syntax_block the code always start on a separate code, expect for C, JavaScript, Peg and with Zig inline assembly. Ensure that the code starts on a separate line, even in cases where there is only one line. Ensure that the end_syntax_block is always on a separate line and that the indentation is consistent.
2023-01-19 11:33:00 +00:00
{#syntax_block|javascript|test.js#}
const fs = require('fs');
docs: wasm
2019-05-20 02:26:10 +00:00
const source = fs.readFileSync("./math.wasm");
const typedArray = new Uint8Array(source);
WebAssembly.instantiate(typedArray, {
env: {
Langref: fix HTML escaped symbol WASM JavaScript code example docgen HTML escapes characters inside of `syntax_block`s. This commit replaces the escaped greater than with the `>` character. No other occurrences were found. Fixes #9840
2021-09-27 02:34:59 +00:00
print: (result) => { console.log(`The result is ${result}`); }
}}).then(result => {
docs: wasm
2019-05-20 02:26:10 +00:00
const add = result.instance.exports.add;
add(1, 2);
langref: always start code on a separate line in a syntax_block In a syntax_block the code always start on a separate code, expect for C, JavaScript, Peg and with Zig inline assembly. Ensure that the code starts on a separate line, even in cases where there is only one line. Ensure that the end_syntax_block is always on a separate line and that the indentation is consistent.
2023-01-19 11:33:00 +00:00
});
{#end_syntax_block#}
{#shell_samp#}$ node test.js
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
The result is 3{#end_shell_samp#}
{#header_close#}
docgen: support wasm and wasi
2019-05-01 22:48:26 +00:00
{#header_open|WASI#}
update docs to latest Target API
2020-02-27 19:41:44 +00:00
<p>Zig's support for WebAssembly System Interface (WASI) is under active development.
Example of using the standard library and reading command line arguments:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|wasi_args.zig#}
Add wasi_ prefix to wasm files
2023-05-15 14:37:56 +00:00
{#shell_samp#}$ wasmtime wasi_args.wasm 123 hello
0: wasi_args.wasm
docs: wasm
2019-05-20 02:26:10 +00:00
1: 123
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
2: hello{#end_shell_samp#}
Add doc example for extracting WASI preopens
2020-06-11 20:06:57 +00:00
<p>A more interesting example would be extracting the list of preopens from the runtime.
langref: Rename std.fs.wasi.{PreopenList => Preopens}
2024-03-18 21:15:06 +00:00
This is now supported in the standard library via {#syntax#}std.fs.wasi.Preopens{#endsyntax#}:</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|wasi_preopens.zig#}
Add doc example for extracting WASI preopens
2020-06-11 20:06:57 +00:00
Add wasi_ prefix to wasm files
2023-05-15 14:37:56 +00:00
{#shell_samp#}$ wasmtime --dir=. wasi_preopens.wasm
langref: update WASI preopens example
2022-12-06 00:21:33 +00:00
0: stdin
1: stdout
2: stderr
3: .
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
{#end_shell_samp#}
docgen: support wasm and wasi
2019-05-01 22:48:26 +00:00
{#header_close#}
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Targets#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
langref: update target section * remove outdated information * add new information closes #17032 closes #17044
2024-01-09 01:48:10 +00:00
<strong>Target</strong> refers to the computer that will be used to run an executable.
It is composed of the CPU architecture, the set of enabled CPU features, operating system,
minimum and maximum operating system version, ABI, and ABI version.
</p>
<p>
Zig is a general-purpose programming language which means that it is designed to
generate optimal code for a large set of targets. The command <code>zig targets</code>
provides information about all of the targets the compiler is aware of.</p>
<p>When no target option is provided to the compiler, the default choice
is to target the <strong>host computer</strong>, meaning that the
resulting executable will be <em>unsuitable for copying to a different
computer</em>. In order to copy an executable to another computer, the compiler
needs to know about the target requirements via the <code>-target</code> option.
</p>
<p>
The Zig Standard Library ({#syntax#}@import("std"){#endsyntax#}) has
cross-platform abstractions, making the same source code viable on many targets.
Some code is more portable than other code. In general, Zig code is extremely
portable compared to other programming languages.
</p>
<p>
Each platform requires its own implementations to make Zig's
cross-platform abstractions work. These implementations are at various
degrees of completion. Each tagged release of the compiler comes with
release notes that provide the full support table for each target.
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Style Guide#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
These coding conventions are not enforced by the compiler, but they are shipped in
this documentation along with the compiler in order to provide a point of
reference, should anyone wish to point to an authority on agreed upon Zig
coding style.
</p>
langref: add naming guide
2024-03-19 06:36:10 +00:00
{#header_open|Avoid Redundancy in Names#}
<p>Avoid these words in type names:</p>
<ul>
<li>Value</li>
<li>Data</li>
<li>Context</li>
<li>Manager</li>
<li>utils, misc, or somebody's initials</li>
</ul>
<p>Everything is a value, all types are data, everything is context, all logic manages state.
std: fix typos (#20560)
2024-07-09 21:25:42 +00:00
Nothing is communicated by using a word that applies to all types.</p>
langref: add naming guide
2024-03-19 06:36:10 +00:00
<p>Temptation to use "utilities", "miscellaneous", or somebody's initials
is a failure to categorize, or more commonly, overcategorization. Such
declarations can live at the root of a module that needs them with no
namespace needed.</p>
{#header_close#}
{#header_open|Avoid Redundant Names in Fully-Qualified Namespaces#}
<p>Every declaration is assigned a <strong>fully qualified
namespace</strong> by the compiler, creating a tree structure. Choose names based
on the fully-qualified namespace, and avoid redundant name segments.</p>
migrate langref documentation generation to the build system
2024-04-25 00:41:47 +00:00
{#code|redundant_fqn.zig#}
langref: add naming guide
2024-03-19 06:36:10 +00:00
<p>In this example, "json" is repeated in the fully-qualified namespace. The solution
is to delete <code>Json</code> from <code>JsonValue</code>. In this example we have
an empty struct named <code>json</code> but remember that files also act
as part of the fully-qualified namespace.</p>
<p>This example is an exception to the rule specified in {#link|Avoid Redundancy in Names#}.
The meaning of the type has been reduced to its core: it is a json value. The name
cannot be any more specific without being incorrect.</p>
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Whitespace#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
<li>
4 space indentation
</li>
<li>
Open braces on same line, unless you need to wrap.
</li>
<li>If a list of things is longer than 2, put each item on its own line and
Fixed typos
2018-11-16 18:33:58 +00:00
exercise the ability to put an extra comma at the end.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</li>
<li>
Line length: aim for 100; use common sense.
</li>
</ul>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Names#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Roughly speaking: {#syntax#}camelCaseFunctionName{#endsyntax#}, {#syntax#}TitleCaseTypeName{#endsyntax#},
{#syntax#}snake_case_variable_name{#endsyntax#}. More precisely:
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
<ul>
<li>
remove namespace type; files are empty structs closes #1047
2019-02-28 15:11:32 +00:00
If {#syntax#}x{#endsyntax#} is a {#syntax#}type{#endsyntax#}
then {#syntax#}x{#endsyntax#} should be {#syntax#}TitleCase{#endsyntax#}, unless it
is a {#syntax#}struct{#endsyntax#} with 0 fields and is never meant to be instantiated,
fix docs typo
2019-03-01 22:23:27 +00:00
in which case it is considered to be a "namespace" and uses {#syntax#}snake_case{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</li>
<li>
remove namespace type; files are empty structs closes #1047
2019-02-28 15:11:32 +00:00
If {#syntax#}x{#endsyntax#} is callable, and {#syntax#}x{#endsyntax#}'s return type is
{#syntax#}type{#endsyntax#}, then {#syntax#}x{#endsyntax#} should be {#syntax#}TitleCase{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</li>
<li>
remove namespace type; files are empty structs closes #1047
2019-02-28 15:11:32 +00:00
If {#syntax#}x{#endsyntax#} is otherwise callable, then {#syntax#}x{#endsyntax#} should
be {#syntax#}camelCase{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</li>
<li>
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
Otherwise, {#syntax#}x{#endsyntax#} should be {#syntax#}snake_case{#endsyntax#}.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</li>
</ul>
<p>
Acronyms, initialisms, proper nouns, or any other word that has capitalization
rules in written English are subject to naming conventions just like any other
word. Even acronyms that are only 2 letters long are subject to these
conventions.
</p>
<p>
Apply naming conventions of structs to files
2020-05-02 21:28:44 +00:00
File names fall into two categories: types and namespaces. If the file
docs: minor spelling fix
2021-06-03 22:04:58 +00:00
(implicitly a struct) has top level fields, it should be named like any
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
other struct with fields using <code class="file">TitleCase</code>. Otherwise,
it should use <code class="file">snake_case</code>. Directory names should be
<code class="file">snake_case</code>.
Apply naming conventions of structs to files
2020-05-02 21:28:44 +00:00
</p>
<p>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
These are general rules of thumb; if it makes sense to do something different,
do what makes sense. For example, if there is an established convention such as
docs: more syntax highlighting
2018-09-14 14:35:03 +00:00
{#syntax#}ENOENT{#endsyntax#}, follow the established convention.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Examples#}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
{#syntax_block|zig|style_example.zig#}
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
const namespace_name = @import("dir_name/file_name.zig");
Apply naming conventions of structs to files
2020-05-02 21:28:44 +00:00
const TypeName = @import("dir_name/TypeName.zig");
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
var global_var: i32 = undefined;
const const_name = 42;
const primitive_type_alias = f32;
const string_alias = []u8;
remove namespace type; files are empty structs closes #1047
2019-02-28 15:11:32 +00:00
const StructName = struct {
field: i32,
};
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
const StructAlias = StructName;
syntax: functions require return type. remove `->` The purpose of this is: * Only one way to do things * Changing a function with void return type to return a possible error becomes a 1 character change, subtly encouraging people to use errors. See #632 Here are some imperfect sed commands for performing this update: remove arrow: ``` sed -i 's/\(\bfn\b.*\)-> /\1/g' $(find . -name "*.zig") ``` add void: ``` sed -i 's/\(\bfn\b.*\))\s*{/\1) void {/g' $(find ../ -name "*.zig") ``` Some cleanup may be necessary, but this should do the bulk of the work.
2018-01-25 09:10:11 +00:00
fn functionName(param_name: TypeName) void {
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
var functionPointer = functionName;
functionPointer();
functionPointer = otherFunction;
functionPointer();
}
const functionAlias = functionName;
syntax: functions require return type. remove `->` The purpose of this is: * Only one way to do things * Changing a function with void return type to return a possible error becomes a 1 character change, subtly encouraging people to use errors. See #632 Here are some imperfect sed commands for performing this update: remove arrow: ``` sed -i 's/\(\bfn\b.*\)-> /\1/g' $(find . -name "*.zig") ``` add void: ``` sed -i 's/\(\bfn\b.*\))\s*{/\1) void {/g' $(find ../ -name "*.zig") ``` Some cleanup may be necessary, but this should do the bulk of the work.
2018-01-25 09:10:11 +00:00
fn ListTemplateFunction(comptime ChildType: type, comptime fixed_size: usize) type {
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
return List(ChildType, fixed_size);
}
syntax: functions require return type. remove `->` The purpose of this is: * Only one way to do things * Changing a function with void return type to return a possible error becomes a 1 character change, subtly encouraging people to use errors. See #632 Here are some imperfect sed commands for performing this update: remove arrow: ``` sed -i 's/\(\bfn\b.*\)-> /\1/g' $(find . -name "*.zig") ``` add void: ``` sed -i 's/\(\bfn\b.*\))\s*{/\1) void {/g' $(find ../ -name "*.zig") ``` Some cleanup may be necessary, but this should do the bulk of the work.
2018-01-25 09:10:11 +00:00
fn ShortList(comptime T: type, comptime n: usize) type {
New Zig formal grammar (#1685) Reverted #1628 and changed the grammar+parser of the language to not allow certain expr where types are expected
2018-11-13 13:08:37 +00:00
return struct {
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
field_name: [n]T,
syntax: functions require return type. remove `->` The purpose of this is: * Only one way to do things * Changing a function with void return type to return a possible error becomes a 1 character change, subtly encouraging people to use errors. See #632 Here are some imperfect sed commands for performing this update: remove arrow: ``` sed -i 's/\(\bfn\b.*\)-> /\1/g' $(find . -name "*.zig") ``` add void: ``` sed -i 's/\(\bfn\b.*\))\s*{/\1) void {/g' $(find ../ -name "*.zig") ``` Some cleanup may be necessary, but this should do the bulk of the work.
2018-01-25 09:10:11 +00:00
fn methodName() void {}
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
};
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
}
// The word XML loses its casing when used in Zig identifiers.
const xml_document =
all doc code examples are now tested improve color scheme of docs make docs depend on no external files fix broken example code in docs closes #465
2018-01-19 08:03:20 +00:00
\\<?xml version="1.0" encoding="UTF-8"?>
\\<document>
\\</document>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
;
remove namespace type; files are empty structs closes #1047
2019-02-28 15:11:32 +00:00
const XmlParser = struct {
field: i32,
};
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
// The initials BE (Big Endian) are just another word in Zig identifier names.
syntax: functions require return type. remove `->` The purpose of this is: * Only one way to do things * Changing a function with void return type to return a possible error becomes a 1 character change, subtly encouraging people to use errors. See #632 Here are some imperfect sed commands for performing this update: remove arrow: ``` sed -i 's/\(\bfn\b.*\)-> /\1/g' $(find . -name "*.zig") ``` add void: ``` sed -i 's/\(\bfn\b.*\))\s*{/\1) void {/g' $(find ../ -name "*.zig") ``` Some cleanup may be necessary, but this should do the bulk of the work.
2018-01-25 09:10:11 +00:00
fn readU32Be() u32 {}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
{#end_syntax_block#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
See the {#link|Zig Standard Library#} for more examples.
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</p>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
std: implement a cross platform file locking abstraction This modifies the lock semantics from using AccessMode to using NtLockFile/NtUnlockFile. This is a breaking change.
2021-06-28 23:46:37 +00:00
{#header_open|Doc Comment Guidance#}
<ul>
<li>Omit any information that is redundant based on the name of the thing being documented.</li>
<li>Duplicating information onto multiple similar functions is encouraged because it helps IDEs and other tools provide better help text.</li>
<li>Use the word <strong>assume</strong> to indicate invariants that cause {#link|Undefined Behavior#} when violated.</li>
<li>Use the word <strong>assert</strong> to indicate invariants that cause <em>safety-checked</em> {#link|Undefined Behavior#} when violated.</li>
</ul>
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
docs: move source encoding section
2018-02-01 01:42:27 +00:00
{#header_open|Source Encoding#}
<p>Zig source code is encoded in UTF-8. An invalid UTF-8 byte sequence results in a compile error.</p>
update docs and grammar to allow CRLF line endings (#8063)
2021-03-03 19:30:46 +00:00
<p>Throughout all zig source code (including in comments), some code points are never allowed:</p>
docs: move source encoding section
2018-02-01 01:42:27 +00:00
<ul>
update docs and grammar to allow CRLF line endings (#8063)
2021-03-03 19:30:46 +00:00
<li>Ascii control characters, except for U+000a (LF), U+000d (CR), and U+0009 (HT): U+0000 - U+0008, U+000b - U+000c, U+000e - U+0001f, U+007f.</li>
docs: move source encoding section
2018-02-01 01:42:27 +00:00
<li>Non-Ascii Unicode line endings: U+0085 (NEL), U+2028 (LS), U+2029 (PS).</li>
</ul>
update docs and grammar to allow CRLF line endings (#8063)
2021-03-03 19:30:46 +00:00
<p>
LF (byte value 0x0a, code point U+000a, {#syntax#}'\n'{#endsyntax#}) is the line terminator in Zig source code.
This byte value terminates every line of zig source code except the last line of the file.
It is recommended that non-empty source files end with an empty line, which means the last byte would be 0x0a (LF).
</p>
<p>
Each LF may be immediately preceded by a single CR (byte value 0x0d, code point U+000d, {#syntax#}'\r'{#endsyntax#})
Fix typo in docs
2023-10-23 05:43:48 +00:00
to form a Windows style line ending, but this is discouraged. Note that in multiline strings, CRLF sequences will
Correctly handle carriage return characters according to the spec (#12661) * Scan from line start when finding tag in tokenizer This resolves a crash that can occur for invalid bytes like carriage returns that are valid characters when not parsed from within literals. There are potentially other edge cases this could resolve as well, as the calling code for this function didn't account for any potential 'pending_invalid_tokens' that could be queued up by the tokenizer from within another state. * Fix carriage return crash in multiline string Follow the guidance of #38: > However CR directly before NL is interpreted as only a newline and not part of the multiline string. zig fmt will delete the CR. Zig fmt already had code for deleting carriage returns, but would still crash - now it no longer does so. Carriage returns encountered before line-feeds are now appropriately removed on program compilation as well. * Only accept carriage returns before line feeds Previous commit was much less strict about this, this more closely matches the desired spec of only allow CR characters in a CRLF pair, but not otherwise. * Fix CR being rejected when used as whitespace Missed this comment from ziglang/zig-spec#83: > CR used as whitespace, whether directly preceding NL or stray, is still unambiguously whitespace. It is accepted by the grammar and replaced by the canonical whitespace by zig fmt. * Add tests for carriage return handling
2023-02-19 12:14:03 +00:00
be encoded as LF when compiled into a zig program.
update docs and grammar to allow CRLF line endings (#8063)
2021-03-03 19:30:46 +00:00
A CR in any other context is not allowed.
</p>
<p>
HT hard tabs (byte value 0x09, code point U+0009, {#syntax#}'\t'{#endsyntax#}) are interchangeable with
SP spaces (byte value 0x20, code point U+0020, {#syntax#}' '{#endsyntax#}) as a token separator,
but use of hard tabs is discouraged. See {#link|Grammar#}.
</p>
<p>
langref: document UTF-8 BOM handling The current compiler ignores the UTF-8 BOM if it is at the start of the file, and disallows it anywhere else. Document it in the Source Encoding section.
2023-01-16 18:14:43 +00:00
For compatibility with other tools, the compiler ignores a UTF-8-encoded byte order mark (U+FEFF)
if it is the first Unicode code point in the source text. A byte order mark is not allowed anywhere else in the source.
</p>
<p>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
Note that running <kbd>zig fmt</kbd> on a source file will implement all recommendations mentioned here.
update docs and grammar to allow CRLF line endings (#8063)
2021-03-03 19:30:46 +00:00
</p>
<p>
Note that a tool reading Zig source code can make assumptions if the source code is assumed to be correct Zig code.
For example, when identifying the ends of lines, a tool can use a naive search such as <code>/\n/</code>,
or an <a href="https://msdn.microsoft.com/en-us/library/dd409797.aspx">advanced</a>
search such as <code>/\r\n?|[\n\u0085\u2028\u2029]/</code>, and in either case line endings will be correctly identified.
For another example, when identifying the whitespace before the first token on a line,
a tool can either use a naive search such as <code>/[ \t]/</code>,
or an <a href="https://tc39.es/ecma262/#sec-characterclassescape">advanced</a> search such as <code>/\s/</code>,
and in either case whitespace will be correctly identified.
</p>
docs: move source encoding section
2018-02-01 01:42:27 +00:00
{#header_close#}
add documentation for `pub` closes #1727
2019-03-13 17:04:55 +00:00
{#header_open|Keyword Reference#}
Add "table-wrapper" div
2020-08-24 22:29:53 +00:00
<div class="table-wrapper">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<table>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<thead>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="col">Keyword</th>
<th scope="col">Description</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
</tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</thead>
<tbody>
langref: add the new addrspace keyword Add the new addrspace keyword in the Keyword Reference section, without documentation. Move the linksection keyword in order to keep the keywords list sorted.
2023-01-16 18:32:24 +00:00
<tr>
<th scope="row">
<pre>{#syntax#}addrspace{#endsyntax#}</pre>
</th>
<td>
The {#syntax#}addrspace{#endsyntax#} keyword.
<ul>
<li>TODO add documentation for addrspace</li>
</ul>
</td>
</tr>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}align{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}align{#endsyntax#} can be used to specify the alignment of a pointer.
It can also be used after a variable or function declaration to specify the alignment of pointers to that variable or function.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|Alignment#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}allowzero{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
The pointer attribute {#syntax#}allowzero{#endsyntax#} allows a pointer to have address zero.
<ul>
<li>See also {#link|allowzero#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}and{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
The boolean operator {#syntax#}and{#endsyntax#}.
<ul>
<li>See also {#link|Operators#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}anyframe{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}anyframe{#endsyntax#} can be used as a type for variables which hold pointers to function frames.
<ul>
<li>See also {#link|Async Functions#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}anytype{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
docs: Remove mention of type inference on anytype struct fields It was removed from the language.
2022-08-27 14:44:05 +00:00
Function parameters can be declared with {#syntax#}anytype{#endsyntax#} in place of the type.
The type will be inferred where the function is called.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|Function Parameter Type Inference#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}asm{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}asm{#endsyntax#} begins an inline assembly expression. This allows for directly controlling the machine code generated on compilation.
<ul>
<li>See also {#link|Assembly#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}async{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}async{#endsyntax#} can be used before a function call to get a pointer to the function's frame when it suspends.
<ul>
<li>See also {#link|Async Functions#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}await{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}await{#endsyntax#} can be used to suspend the current function until the frame provided after the {#syntax#}await{#endsyntax#} completes.
{#syntax#}await{#endsyntax#} copies the value returned from the target function's frame to the caller.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|Async Functions#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}break{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}break{#endsyntax#} can be used with a block label to return a value from the block.
It can also be used to exit a loop before iteration completes naturally.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
langref: mention `void{}` and empty blocks closes #11112 closes #12496
2022-10-30 23:27:02 +00:00
<li>See also {#link|Blocks#}, {#link|while#}, {#link|for#}</li>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
</ul>
</td>
</tr>
langref: keyword consistency (between keyword list and grammar) Add missing keywords in Keyword Reference. Reorder keywords in grammar.
2023-09-06 16:10:24 +00:00
<tr>
<th scope="row">
<pre>{#syntax#}callconv{#endsyntax#}</pre>
</th>
<td>
{#syntax#}callconv{#endsyntax#} can be used to specify the calling convention in a function type.
<ul>
<li>See also {#link|Functions#}</li>
</ul>
</td>
</tr>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}catch{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}catch{#endsyntax#} can be used to evaluate an expression if the expression before it evaluates to an error.
The expression after the {#syntax#}catch{#endsyntax#} can optionally capture the error value.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|catch#}, {#link|Operators#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}comptime{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}comptime{#endsyntax#} before a declaration can be used to label variables or function parameters as known at compile time.
It can also be used to guarantee an expression is run at compile time.
<ul>
<li>See also {#link|comptime#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}const{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}const{#endsyntax#} declares a variable that can not be modified.
Make changes
2020-08-24 18:12:23 +00:00
Used as a pointer attribute, it denotes the value referenced by the pointer cannot be modified.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|Variables#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}continue{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}continue{#endsyntax#} can be used in a loop to jump back to the beginning of the loop.
<ul>
<li>See also {#link|while#}, {#link|for#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}defer{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}defer{#endsyntax#} will execute an expression when control flow leaves the current block.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|defer#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}else{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}else{#endsyntax#} can be used to provide an alternate branch for {#syntax#}if{#endsyntax#}, {#syntax#}switch{#endsyntax#},
{#syntax#}while{#endsyntax#}, and {#syntax#}for{#endsyntax#} expressions.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>If used after an if expression, the else branch will be executed if the test value returns false, null, or an error.</li>
<li>If used within a switch expression, the else branch will be executed if the test value matches no other cases.</li>
<li>If used after a loop expression, the else branch will be executed if the loop finishes without breaking.</li>
<li>See also {#link|if#}, {#link|switch#}, {#link|while#}, {#link|for#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}enum{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}enum{#endsyntax#} defines an enum type.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|enum#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}errdefer{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
docs: add documentation on errdefer with caputure syntax Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2022-05-17 19:03:42 +00:00
{#syntax#}errdefer{#endsyntax#} will execute an expression when control flow leaves the current block if the function returns an error, the errdefer expression can capture the unwrapped value.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|errdefer#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}error{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}error{#endsyntax#} defines an error type.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|Errors#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}export{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}export{#endsyntax#} makes a function or variable externally visible in the generated object file.
Exported functions default to the C calling convention.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|Functions#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}extern{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}extern{#endsyntax#} can be used to declare a function or variable that will be resolved at link time, when linking statically
or at runtime, when linking dynamically.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|Functions#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}fn{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}fn{#endsyntax#} declares a function.
<ul>
<li>See also {#link|Functions#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}for{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
A {#syntax#}for{#endsyntax#} expression can be used to iterate over the elements of a slice, array, or tuple.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|for#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}if{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
An {#syntax#}if{#endsyntax#} expression can test boolean expressions, optional values, or error unions.
For optional values or error unions, the if expression can capture the unwrapped value.
<ul>
<li>See also {#link|if#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}inline{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}inline{#endsyntax#} can be used to label a loop expression such that it will be unrolled at compile time.
It can also be used to force a function to be inlined at all call sites.
<ul>
<li>See also {#link|inline while#}, {#link|inline for#}, {#link|Functions#}</li>
</ul>
</td>
</tr>
langref: add the new addrspace keyword Add the new addrspace keyword in the Keyword Reference section, without documentation. Move the linksection keyword in order to keep the keywords list sorted.
2023-01-16 18:32:24 +00:00
<tr>
<th scope="row">
<pre>{#syntax#}linksection{#endsyntax#}</pre>
</th>
<td>
Documented `linksection` Fixes #1520
2023-09-11 07:54:59 +00:00
The {#syntax#}linksection{#endsyntax#} keyword can be used to specify what section the function or global variable will be put into (e.g. <code>.text</code>).
langref: add the new addrspace keyword Add the new addrspace keyword in the Keyword Reference section, without documentation. Move the linksection keyword in order to keep the keywords list sorted.
2023-01-16 18:32:24 +00:00
</td>
</tr>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}noalias{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
The {#syntax#}noalias{#endsyntax#} keyword.
<ul>
<li>TODO add documentation for noalias</li>
</ul>
</td>
</tr>
langref: add documentation for noinline keyword
2023-04-22 11:43:37 +00:00
<tr>
<th scope="row">
<pre>{#syntax#}noinline{#endsyntax#}</pre>
</th>
<td>
{#syntax#}noinline{#endsyntax#} disallows function to be inlined in all call sites.
<ul>
<li>See also {#link|Functions#}</li>
</ul>
</td>
</tr>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}nosuspend{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
docs: document the nosuspend keyword (#7972) * docs: document the nosuspend keyword * Specify that resuming from suspend is allowed in nosuspend * Fix the description of the requirements of nosuspend * Make use of nosuspend in some example code. This is mainly motivated by the incorrect claim that "there would be no way to collect the return value of amain, if it were something other than void".
2021-04-02 18:57:42 +00:00
The {#syntax#}nosuspend{#endsyntax#} keyword can be used in front of a block, statement or expression, to mark a scope where no suspension points are reached.
In particular, inside a {#syntax#}nosuspend{#endsyntax#} scope:
<ul>
<li>Using the {#syntax#}suspend{#endsyntax#} keyword results in a compile error.</li>
<li>Using {#syntax#}await{#endsyntax#} on a function frame which hasn't completed yet results in safety-checked {#link|Undefined Behavior#}.</li>
<li>Calling an async function may result in safety-checked {#link|Undefined Behavior#}, because it's equivalent to <code>await async some_async_fn()</code>, which contains an {#syntax#}await{#endsyntax#}.</li>
</ul>
Code inside a {#syntax#}nosuspend{#endsyntax#} scope does not cause the enclosing function to become an {#link|async function|Async Functions#}.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
docs: document the nosuspend keyword (#7972) * docs: document the nosuspend keyword * Specify that resuming from suspend is allowed in nosuspend * Fix the description of the requirements of nosuspend * Make use of nosuspend in some example code. This is mainly motivated by the incorrect claim that "there would be no way to collect the return value of amain, if it were something other than void".
2021-04-02 18:57:42 +00:00
<li>See also {#link|Async Functions#}</li>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
</ul>
</td>
</tr>
langref: keyword consistency (between keyword list and grammar) Add missing keywords in Keyword Reference. Reorder keywords in grammar.
2023-09-06 16:10:24 +00:00
<tr>
<th scope="row">
<pre>{#syntax#}opaque{#endsyntax#}</pre>
</th>
<td>
{#syntax#}opaque{#endsyntax#} defines an opaque type.
<ul>
<li>See also {#link|opaque#}</li>
</ul>
</td>
</tr>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}or{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
The boolean operator {#syntax#}or{#endsyntax#}.
<ul>
<li>See also {#link|Operators#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}orelse{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}orelse{#endsyntax#} can be used to evaluate an expression if the expression before it evaluates to null.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|Optionals#}, {#link|Operators#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}packed{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
The {#syntax#}packed{#endsyntax#} keyword before a struct definition changes the struct's in-memory layout
to the guaranteed {#syntax#}packed{#endsyntax#} layout.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|packed struct#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}pub{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
The {#syntax#}pub{#endsyntax#} in front of a top level declaration makes the declaration available
to reference from a different file than the one it is declared in.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|import#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}resume{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}resume{#endsyntax#} will continue execution of a function frame after the point the function was suspended.
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}return{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}return{#endsyntax#} exits a function with a value.
<ul>
<li>See also {#link|Functions#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}struct{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}struct{#endsyntax#} defines a struct.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|struct#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}suspend{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}suspend{#endsyntax#} will cause control flow to return to the call site or resumer of the function.
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}suspend{#endsyntax#} can also be used before a block within a function,
to allow the function access to its frame before control flow returns to the call site.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}switch{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
A {#syntax#}switch{#endsyntax#} expression can be used to test values of a common type.
{#syntax#}switch{#endsyntax#} cases can capture field values of a {#link|Tagged union#}.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|switch#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}test{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
The {#syntax#}test{#endsyntax#} keyword can be used to denote a top-level block of code
used to make sure behavior meets expectations.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|Zig Test#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}threadlocal{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}threadlocal{#endsyntax#} can be used to specify a variable as thread-local.
<ul>
<li>See also {#link|Thread Local Variables#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}try{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}try{#endsyntax#} evaluates an error union expression.
If it is an error, it returns from the current function with the same error.
Otherwise, the expression results in the unwrapped value.
<ul>
<li>See also {#link|try#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}union{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}union{#endsyntax#} defines a union.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|union#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}unreachable{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}unreachable{#endsyntax#} can be used to assert that control flow will never happen upon a particular location.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
Depending on the build mode, {#syntax#}unreachable{#endsyntax#} may emit a panic.
<ul>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<li>Emits a panic in {#syntax#}Debug{#endsyntax#} and {#syntax#}ReleaseSafe{#endsyntax#} mode, or when using <kbd>zig test</kbd>.</li>
langref: add missing ReleaseSmall when describing unreachable (#13909) Add a missing ReleaseSmall when describing unreachable in the try section and the unreachable entry in the Keyword Reference section. Additionally, transform Debug, ReleaseSafe, ReleaseFast and ReleaseSmall into links in the try section. Co-authored-by: Andrew Kelley <andrew@ziglang.org>
2022-12-13 20:02:17 +00:00
<li>Does not emit a panic in {#syntax#}ReleaseFast{#endsyntax#} and {#syntax#}ReleaseSmall{#endsyntax#} mode.</li>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<li>See also {#link|unreachable#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}usingnamespace{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
{#syntax#}usingnamespace{#endsyntax#} is a top-level declaration that imports all the public declarations of the operand,
which must be a struct, union, or enum, into the current scope.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|usingnamespace#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}var{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}var{#endsyntax#} declares a variable that may be modified.
<ul>
<li>See also {#link|Variables#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}volatile{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
{#syntax#}volatile{#endsyntax#} can be used to denote loads or stores of a pointer have side effects.
It can also modify an inline assembly expression to denote it has side effects.
<ul>
<li>See also {#link|volatile#}, {#link|Assembly#}</li>
</ul>
</td>
</tr>
<tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
<th scope="row">
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<pre>{#syntax#}while{#endsyntax#}</pre>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</th>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<td>
Make changes
2020-08-24 18:12:23 +00:00
A {#syntax#}while{#endsyntax#} expression can be used to repeatedly test a boolean, optional, or error union expression,
and cease looping when that expression evaluates to false, null, or an error, respectively.
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
<ul>
<li>See also {#link|while#}</li>
</ul>
</td>
</tr>
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</tbody>
Add Keyword Reference section
2020-08-24 15:59:55 +00:00
</table>
Add "table-wrapper" div
2020-08-24 22:29:53 +00:00
</div>
add documentation for `pub` closes #1727
2019-03-13 17:04:55 +00:00
{#header_close#}
langref: add appendix and explain 'container' terminology
2022-11-09 08:29:50 +00:00
{#header_open|Appendix#}
{#header_open|Containers#}
<p>
A <em>container</em> in Zig is any syntactical construct that acts as a namespace to hold {#link|variable|Container Level Variables#} and {#link|function|Functions#} declarations.
Containers are also type definitions which can be instantiated.
{#link|Structs|struct#}, {#link|enums|enum#}, {#link|unions|union#}, {#link|opaques|opaque#}, and even Zig source files themselves are containers.
</p>
<p>
Although containers (except Zig source files) use curly braces to surround their definition, they should not be confused with {#link|blocks|Blocks#} or functions.
Containers do not contain statements.
</p>
{#header_close#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_open|Grammar#}
langref: always start code on a separate line in a syntax_block In a syntax_block the code always start on a separate code, expect for C, JavaScript, Peg and with Zig inline assembly. Ensure that the code starts on a separate line, even in cases where there is only one line. Ensure that the end_syntax_block is always on a separate line and that the indentation is consistent.
2023-01-19 11:33:00 +00:00
{#syntax_block|peg|grammar.y#}
Root <- skip container_doc_comment? ContainerMembers eof
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
# *** Top level ***
Grammar: Use `ContainerDeclaration*` instead of `ContainerDeclarations` `ContainerDeclarations` is an abstraction of `ContainerDeclaration*`. Removing this abstraction allows the `ContainerMembers` rule to contain more concrete information without having to look at the definition of `ContainerDeclarations`.
2023-10-09 14:26:53 +00:00
ContainerMembers <- ContainerDeclaration* (ContainerField COMMA)* (ContainerField / ContainerDeclaration*)
langref: sync grammar with zig-spec repo
2021-05-28 19:21:14 +00:00
Grammar: Use `ContainerDeclaration*` instead of `ContainerDeclarations` `ContainerDeclarations` is an abstraction of `ContainerDeclaration*`. Removing this abstraction allows the `ContainerMembers` rule to contain more concrete information without having to look at the definition of `ContainerDeclarations`.
2023-10-09 14:26:53 +00:00
ContainerDeclaration <- TestDecl / ComptimeDecl / doc_comment? KEYWORD_pub? Decl
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
AstGen: make type sentinel expressions implicitly comptime
2022-12-28 10:34:41 +00:00
TestDecl <- KEYWORD_test (STRINGLITERALSINGLE / IDENTIFIER)? Block
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
ComptimeDecl <- KEYWORD_comptime Block
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
Decl
docs: remove unnecessary nesting in grammar noticed this extra level of nesting in the Decl grammar that looks unnecssary.
2023-09-28 06:10:41 +00:00
<- (KEYWORD_export / KEYWORD_extern STRINGLITERALSINGLE? / KEYWORD_inline / KEYWORD_noinline)? FnProto (SEMICOLON / Block)
langref: apply grammar changes This applies the changes to the grammar introduced by the new destructuring syntax, as well as some existing changes which were not copied into the langref.
2023-09-14 23:49:15 +00:00
/ (KEYWORD_export / KEYWORD_extern STRINGLITERALSINGLE?)? KEYWORD_threadlocal? GlobalVarDecl
stage1 parser supports doc comments
2019-10-06 20:39:27 +00:00
/ KEYWORD_usingnamespace Expr SEMICOLON
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
FnProto <- KEYWORD_fn IDENTIFIER? LPAREN ParamDeclList RPAREN ByteAlign? AddrSpace? LinkSection? CallConv? EXCLAMATIONMARK? TypeExpr
wip bring back export keyword
2017-12-19 06:19:49 +00:00
langref: apply grammar changes This applies the changes to the grammar introduced by the new destructuring syntax, as well as some existing changes which were not copied into the langref.
2023-09-14 23:49:15 +00:00
VarDeclProto <- (KEYWORD_const / KEYWORD_var) IDENTIFIER (COLON TypeExpr)? ByteAlign? AddrSpace? LinkSection?
GlobalVarDecl <- VarDeclProto (EQUAL Expr)? SEMICOLON
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
grammar: remove gratuitous ambiguity Previously, the following matched both ContainerField alternatives: * [IDENTIFIER] * [IDENTIFIER][COLON][TypeExpr]
2024-03-06 05:49:17 +00:00
ContainerField <- doc_comment? KEYWORD_comptime? !KEYWORD_fn (IDENTIFIER COLON)? TypeExpr ByteAlign? (EQUAL Expr)?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
# *** Block Level ***
Statement
langref: apply grammar changes This applies the changes to the grammar introduced by the new destructuring syntax, as well as some existing changes which were not copied into the langref.
2023-09-14 23:49:15 +00:00
<- KEYWORD_comptime ComptimeStatement
remove useless nosuspend parsing nosuspend cannot be used in a type expression and all other use casesare covered by PrimaryExpr
2020-05-14 08:19:14 +00:00
/ KEYWORD_nosuspend BlockExprStatement
langref: sync grammar with zig-spec repo
2021-05-28 19:21:14 +00:00
/ KEYWORD_suspend BlockExprStatement
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ KEYWORD_defer BlockExprStatement
langref: sync grammar with zig-spec repo
2021-05-28 19:21:14 +00:00
/ KEYWORD_errdefer Payload? BlockExprStatement
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ IfStatement
/ LabeledStatement
/ SwitchExpr
langref: apply grammar changes This applies the changes to the grammar introduced by the new destructuring syntax, as well as some existing changes which were not copied into the langref.
2023-09-14 23:49:15 +00:00
/ VarDeclExprStatement
ComptimeStatement
<- BlockExpr
/ VarDeclExprStatement
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
IfStatement
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- IfPrefix BlockExpr ( KEYWORD_else Payload? Statement )?
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ IfPrefix AssignExpr ( SEMICOLON / KEYWORD_else Payload? Statement )
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
LabeledStatement <- BlockLabel? (Block / LoopStatement)
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
LoopStatement <- KEYWORD_inline? (ForStatement / WhileStatement)
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
ForStatement
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- ForPrefix BlockExpr ( KEYWORD_else Statement )?
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ ForPrefix AssignExpr ( SEMICOLON / KEYWORD_else Statement )
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
WhileStatement
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- WhilePrefix BlockExpr ( KEYWORD_else Payload? Statement )?
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ WhilePrefix AssignExpr ( SEMICOLON / KEYWORD_else Payload? Statement )
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
BlockExprStatement
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- BlockExpr
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ AssignExpr SEMICOLON
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
BlockExpr <- BlockLabel? Block
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: apply grammar changes This applies the changes to the grammar introduced by the new destructuring syntax, as well as some existing changes which were not copied into the langref.
2023-09-14 23:49:15 +00:00
# An expression, assignment, or any destructure, as a statement.
VarDeclExprStatement
<- VarDeclProto (COMMA (VarDeclProto / Expr))* EQUAL Expr SEMICOLON
/ Expr (AssignOp Expr / (COMMA (VarDeclProto / Expr))+ EQUAL Expr)? SEMICOLON
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
# *** Expression Level ***
langref: apply grammar changes This applies the changes to the grammar introduced by the new destructuring syntax, as well as some existing changes which were not copied into the langref.
2023-09-14 23:49:15 +00:00
# An assignment or a destructure whose LHS are all lvalue expressions.
AssignExpr <- Expr (AssignOp Expr / (COMMA Expr)+ EQUAL Expr)?
SingleAssignExpr <- Expr (AssignOp Expr)?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
Expr <- BoolOrExpr
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
BoolOrExpr <- BoolAndExpr (KEYWORD_or BoolAndExpr)*
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
BoolAndExpr <- CompareExpr (KEYWORD_and CompareExpr)*
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
CompareExpr <- BitwiseExpr (CompareOp BitwiseExpr)?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
BitwiseExpr <- BitShiftExpr (BitwiseOp BitShiftExpr)*
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
BitShiftExpr <- AdditionExpr (BitShiftOp AdditionExpr)*
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
AdditionExpr <- MultiplyExpr (AdditionOp MultiplyExpr)*
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
MultiplyExpr <- PrefixExpr (MultiplyOp PrefixExpr)*
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
PrefixExpr <- PrefixOp* PrimaryExpr
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
PrimaryExpr
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- AsmExpr
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ IfExpr
/ KEYWORD_break BreakLabel? Expr?
/ KEYWORD_comptime Expr
remove useless nosuspend parsing nosuspend cannot be used in a type expression and all other use casesare covered by PrimaryExpr
2020-05-14 08:19:14 +00:00
/ KEYWORD_nosuspend Expr
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ KEYWORD_continue BreakLabel?
/ KEYWORD_resume Expr
/ KEYWORD_return Expr?
Updated langref to newest grammar
2019-03-22 08:01:30 +00:00
/ BlockLabel? LoopExpr
/ Block
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ CurlySuffixExpr
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
IfExpr <- IfPrefix Expr (KEYWORD_else Payload? Expr)?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
Block <- LBRACE Statement* RBRACE
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
LoopExpr <- KEYWORD_inline? (ForExpr / WhileExpr)
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
ForExpr <- ForPrefix Expr (KEYWORD_else Expr)?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
WhileExpr <- WhilePrefix Expr (KEYWORD_else Payload? Expr)?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
CurlySuffixExpr <- TypeExpr InitList?
Sync grammar with spec - Remove rule LabeledExpr - Add rule CurlySuffixExpr
2019-04-24 04:02:10 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
InitList
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- LBRACE FieldInit (COMMA FieldInit)* COMMA? RBRACE
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ LBRACE Expr (COMMA Expr)* COMMA? RBRACE
/ LBRACE RBRACE
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
TypeExpr <- PrefixTypeOp* ErrorUnionExpr
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
ErrorUnionExpr <- SuffixExpr (EXCLAMATIONMARK TypeExpr)?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
SuffixExpr
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- KEYWORD_async PrimaryTypeExpr SuffixOp* FnCallArguments
Updated docs to newest grammar
2018-11-17 13:36:36 +00:00
/ PrimaryTypeExpr (SuffixOp / FnCallArguments)*
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
PrimaryTypeExpr
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- BUILTINIDENTIFIER FnCallArguments
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ CHAR_LITERAL
/ ContainerDecl
added grammar rule for enum literal to docs
2019-05-11 18:26:41 +00:00
/ DOT IDENTIFIER
docs: update grammar to remove C strings and add anon literals
2020-01-12 08:35:30 +00:00
/ DOT InitList
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ ErrorSetDecl
/ FLOAT
/ FnProto
/ GroupedExpr
/ LabeledTypeExpr
/ IDENTIFIER
/ IfTypeExpr
/ INTEGER
/ KEYWORD_comptime TypeExpr
/ KEYWORD_error DOT IDENTIFIER
fix infinite loop with mismatced bracket
2020-05-15 20:38:40 +00:00
/ KEYWORD_anyframe
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ KEYWORD_unreachable
/ STRINGLITERAL
/ SwitchExpr
replace `%return` with `try` See #632 better fits the convention of using keywords for control flow
2018-01-07 21:51:46 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
ContainerDecl <- (KEYWORD_extern / KEYWORD_packed)? ContainerDeclAuto
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
ErrorSetDecl <- KEYWORD_error LBRACE IdentifierList RBRACE
parse await and suspend syntax See #727
2018-02-26 05:04:11 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
GroupedExpr <- LPAREN Expr RPAREN
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
IfTypeExpr <- IfPrefix TypeExpr (KEYWORD_else Payload? TypeExpr)?
parse async fn calls and cancel expressions
2018-02-20 05:05:38 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
LabeledTypeExpr
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- BlockLabel Block
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ BlockLabel? LoopTypeExpr
implement coroutine resume
2018-03-01 03:18:48 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
LoopTypeExpr <- KEYWORD_inline? (ForTypeExpr / WhileTypeExpr)
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
ForTypeExpr <- ForPrefix TypeExpr (KEYWORD_else TypeExpr)?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
WhileTypeExpr <- WhilePrefix TypeExpr (KEYWORD_else Payload? TypeExpr)?
parse await and suspend syntax See #727
2018-02-26 05:04:11 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
SwitchExpr <- KEYWORD_switch LPAREN Expr RPAREN LBRACE SwitchProngList RBRACE
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
# *** Assembly ***
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
AsmExpr <- KEYWORD_asm KEYWORD_volatile? LPAREN Expr AsmOutput? RPAREN
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
AsmOutput <- COLON AsmOutputList AsmInput?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
AsmOutputItem <- LBRACKET IDENTIFIER RBRACKET STRINGLITERAL LPAREN (MINUSRARROW TypeExpr / IDENTIFIER) RPAREN
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
AsmInput <- COLON AsmInputList AsmClobbers?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
AsmInputItem <- LBRACKET IDENTIFIER RBRACKET STRINGLITERAL LPAREN Expr RPAREN
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
AsmClobbers <- COLON StringList
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
# *** Helper grammar ***
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
BreakLabel <- COLON IDENTIFIER
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
BlockLabel <- IDENTIFIER COLON
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
FieldInit <- DOT IDENTIFIER EQUAL Expr
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
WhileContinueExpr <- COLON LPAREN AssignExpr RPAREN
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
LinkSection <- KEYWORD_linksection LPAREN Expr RPAREN
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
AddrSpace <- KEYWORD_addrspace LPAREN Expr RPAREN
langref: sync grammar with zig-spec repo
2021-05-28 19:21:14 +00:00
# Fn specific
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
CallConv <- KEYWORD_callconv LPAREN Expr RPAREN
update grammar in langref
2020-11-22 19:15:12 +00:00
langref: sync grammar with zig-spec repo
2021-05-28 19:21:14 +00:00
ParamDecl
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- doc_comment? (KEYWORD_noalias / KEYWORD_comptime)? (IDENTIFIER COLON)? ParamType
langref: sync grammar with zig-spec repo
2021-05-28 19:21:14 +00:00
/ DOT3
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
ParamType
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- KEYWORD_anytype
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ TypeExpr
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
# Control flow prefixes
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
IfPrefix <- KEYWORD_if LPAREN Expr RPAREN PtrPayload?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
WhilePrefix <- KEYWORD_while LPAREN Expr RPAREN PtrPayload? WhileContinueExpr?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: apply grammar changes This applies the changes to the grammar introduced by the new destructuring syntax, as well as some existing changes which were not copied into the langref.
2023-09-14 23:49:15 +00:00
ForPrefix <- KEYWORD_for LPAREN ForArgumentsList RPAREN PtrListPayload
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
# Payloads
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
Payload <- PIPE IDENTIFIER PIPE
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
PtrPayload <- PIPE ASTERISK? IDENTIFIER PIPE
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
PtrIndexPayload <- PIPE ASTERISK? IDENTIFIER (COMMA IDENTIFIER)? PIPE
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: apply grammar changes This applies the changes to the grammar introduced by the new destructuring syntax, as well as some existing changes which were not copied into the langref.
2023-09-14 23:49:15 +00:00
PtrListPayload <- PIPE ASTERISK? IDENTIFIER (COMMA ASTERISK? IDENTIFIER)* COMMA? PIPE
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
# Switch specific
langref: apply grammar changes This applies the changes to the grammar introduced by the new destructuring syntax, as well as some existing changes which were not copied into the langref.
2023-09-14 23:49:15 +00:00
SwitchProng <- KEYWORD_inline? SwitchCase EQUALRARROW PtrIndexPayload? SingleAssignExpr
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
SwitchCase
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- SwitchItem (COMMA SwitchItem)* COMMA?
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ KEYWORD_else
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
SwitchItem <- Expr (DOT3 Expr)?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
langref: apply grammar changes This applies the changes to the grammar introduced by the new destructuring syntax, as well as some existing changes which were not copied into the langref.
2023-09-14 23:49:15 +00:00
# For specific
ForArgumentsList <- ForItem (COMMA ForItem)* COMMA?
ForItem <- Expr (DOT2 Expr?)?
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
# Operators
AssignOp
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- ASTERISKEQUAL
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
/ ASTERISKPIPEEQUAL
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ SLASHEQUAL
/ PERCENTEQUAL
/ PLUSEQUAL
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
/ PLUSPIPEEQUAL
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ MINUSEQUAL
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
/ MINUSPIPEEQUAL
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ LARROW2EQUAL
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
/ LARROW2PIPEEQUAL
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ RARROW2EQUAL
/ AMPERSANDEQUAL
/ CARETEQUAL
/ PIPEEQUAL
/ ASTERISKPERCENTEQUAL
/ PLUSPERCENTEQUAL
/ MINUSPERCENTEQUAL
/ EQUAL
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
CompareOp
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- EQUALEQUAL
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ EXCLAMATIONMARKEQUAL
/ LARROW
/ RARROW
/ LARROWEQUAL
/ RARROWEQUAL
add promise->T syntax parsing closes #857
2018-03-24 23:25:53 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
BitwiseOp
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- AMPERSAND
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ CARET
/ PIPE
/ KEYWORD_orelse
/ KEYWORD_catch Payload?
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
BitShiftOp
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- LARROW2
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ RARROW2
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
/ LARROW2PIPE
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
AdditionOp
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- PLUS
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ MINUS
/ PLUS2
/ PLUSPERCENT
/ MINUSPERCENT
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
/ PLUSPIPE
/ MINUSPIPE
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
MultiplyOp
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- PIPE2
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ ASTERISK
/ SLASH
/ PERCENT
/ ASTERISK2
/ ASTERISKPERCENT
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
/ ASTERISKPIPE
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
PrefixOp
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- EXCLAMATIONMARK
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ MINUS
/ TILDE
/ MINUSPERCENT
/ AMPERSAND
/ KEYWORD_try
/ KEYWORD_await
PrefixTypeOp
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- QUESTIONMARK
fix infinite loop with mismatced bracket
2020-05-15 20:38:40 +00:00
/ KEYWORD_anyframe MINUSRARROW
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
/ SliceTypeStart (ByteAlign / AddrSpace / KEYWORD_const / KEYWORD_volatile / KEYWORD_allowzero)*
AstGen: make type sentinel expressions implicitly comptime
2022-12-28 10:34:41 +00:00
/ PtrTypeStart (AddrSpace / KEYWORD_align LPAREN Expr (COLON Expr COLON Expr)? RPAREN / KEYWORD_const / KEYWORD_volatile / KEYWORD_allowzero)*
langref: sync grammar with zig-spec repo
2021-05-28 19:21:14 +00:00
/ ArrayTypeStart
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
SuffixOp
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- LBRACKET Expr (DOT2 (Expr? (COLON Expr)?)?)? RBRACKET
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ DOT IDENTIFIER
/ DOTASTERISK
/ DOTQUESTIONMARK
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
FnCallArguments <- LPAREN ExprList RPAREN
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
# Ptr specific
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
SliceTypeStart <- LBRACKET (COLON Expr)? RBRACKET
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
PtrTypeStart
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- ASTERISK
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ ASTERISK2
update grammar in langref
2020-11-22 19:15:12 +00:00
/ LBRACKET ASTERISK (LETTERC / COLON Expr)? RBRACKET
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
ArrayTypeStart <- LBRACKET Expr (COLON Expr)? RBRACKET
langref: sync grammar with zig-spec repo
2021-05-28 19:21:14 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
# ContainerDecl specific
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
ContainerDeclAuto <- ContainerDeclType LBRACE container_doc_comment? ContainerMembers RBRACE
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
ContainerDeclType
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
<- KEYWORD_struct (LPAREN Expr RPAREN)?
update grammar in langref
2020-11-22 19:15:12 +00:00
/ KEYWORD_opaque
/ KEYWORD_enum (LPAREN Expr RPAREN)?
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
/ KEYWORD_union (LPAREN (KEYWORD_enum (LPAREN Expr RPAREN)? / Expr) RPAREN)?
# Alignment
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
ByteAlign <- KEYWORD_align LPAREN Expr RPAREN
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
# Lists
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
IdentifierList <- (doc_comment? IDENTIFIER COMMA)* (doc_comment? IDENTIFIER)?
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
SwitchProngList <- (SwitchProng COMMA)* SwitchProng?
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
AsmOutputList <- (AsmOutputItem COMMA)* AsmOutputItem?
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
AsmInputList <- (AsmInputItem COMMA)* AsmInputItem?
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
StringList <- (STRINGLITERAL COMMA)* STRINGLITERAL?
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
ParamDeclList <- (ParamDecl COMMA)* ParamDecl?
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
ExprList <- (Expr COMMA)* Expr?
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
# *** Tokens ***
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
eof <- !.
bin <- [01]
bin_ <- '_'? bin
oct <- [0-7]
oct_ <- '_'? oct
hex <- [0-9a-fA-F]
hex_ <- '_'? hex
dec <- [0-9]
dec_ <- '_'? dec
bin_int <- bin bin_*
oct_int <- oct oct_*
dec_int <- dec dec_*
hex_int <- hex hex_*
ox80_oxBF <- [\200-\277]
oxF4 <- '\364'
ox80_ox8F <- [\200-\217]
oxF1_oxF3 <- [\361-\363]
oxF0 <- '\360'
ox90_0xBF <- [\220-\277]
oxEE_oxEF <- [\356-\357]
oxED <- '\355'
ox80_ox9F <- [\200-\237]
oxE1_oxEC <- [\341-\354]
oxE0 <- '\340'
oxA0_oxBF <- [\240-\277]
oxC2_oxDF <- [\302-\337]
langref: sync grammar with zig-spec repo
2021-05-28 19:21:14 +00:00
# From https://lemire.me/blog/2018/05/09/how-quickly-can-you-check-that-a-string-is-valid-unicode-utf-8/
# First Byte Second Byte Third Byte Fourth Byte
# [0x00,0x7F]
# [0xC2,0xDF] [0x80,0xBF]
# 0xE0 [0xA0,0xBF] [0x80,0xBF]
# [0xE1,0xEC] [0x80,0xBF] [0x80,0xBF]
# 0xED [0x80,0x9F] [0x80,0xBF]
# [0xEE,0xEF] [0x80,0xBF] [0x80,0xBF]
# 0xF0 [0x90,0xBF] [0x80,0xBF] [0x80,0xBF]
# [0xF1,0xF3] [0x80,0xBF] [0x80,0xBF] [0x80,0xBF]
# 0xF4 [0x80,0x8F] [0x80,0xBF] [0x80,0xBF]
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
mb_utf8_literal <-
langref: sync grammar with zig-spec repo
2021-05-28 19:21:14 +00:00
oxF4 ox80_ox8F ox80_oxBF ox80_oxBF
/ oxF1_oxF3 ox80_oxBF ox80_oxBF ox80_oxBF
/ oxF0 ox90_0xBF ox80_oxBF ox80_oxBF
/ oxEE_oxEF ox80_oxBF ox80_oxBF
/ oxED ox80_ox9F ox80_oxBF
/ oxE1_oxEC ox80_oxBF ox80_oxBF
/ oxE0 oxA0_oxBF ox80_oxBF
/ oxC2_oxDF ox80_oxBF
grammar: fix ASCII range typo
2024-04-02 09:22:19 +00:00
ascii_char_not_nl_slash_squote <- [\000-\011\013-\046\050-\133\135-\177]
update grammar in langref
2020-11-22 19:15:12 +00:00
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
char_escape
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- "\\x" hex hex
/ "\\u{" hex+ "}"
/ "\\" [nr\\t'"]
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
char_char
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- mb_utf8_literal
langref: sync grammar with zig-spec repo
2021-05-28 19:21:14 +00:00
/ char_escape
/ ascii_char_not_nl_slash_squote
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
string_char
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- char_escape
/ [^\\"\n]
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
zig fmt: improve handling of comptime tuple fields
2022-12-27 11:52:37 +00:00
container_doc_comment <- ('//!' [^\n]* [ \n]* skip)+
doc_comment <- ('///' [^\n]* [ \n]* skip)+
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
line_comment <- '//' ![!/][^\n]* / '////' [^\n]*
line_string <- ("\\\\" [^\n]* [ \n]*)+
skip <- ([ \n] / line_comment)*
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
CHAR_LITERAL <- "'" char_char "'" skip
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
FLOAT
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- "0x" hex_int "." hex_int ([pP] [-+]? dec_int)? skip
/ dec_int "." dec_int ([eE] [-+]? dec_int)? skip
/ "0x" hex_int [pP] [-+]? dec_int skip
/ dec_int [eE] [-+]? dec_int skip
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
INTEGER
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- "0b" bin_int skip
/ "0o" oct_int skip
/ "0x" hex_int skip
update grammar in langref
2020-11-22 19:15:12 +00:00
/ dec_int skip
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
STRINGLITERALSINGLE <- "\"" string_char* "\"" skip
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
STRINGLITERAL
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- STRINGLITERALSINGLE
langref: sync grammar with zig-spec repo
2021-05-28 19:21:14 +00:00
/ (line_string skip)+
Manual update to new grammar. TODO: Figure out how we can auto update this, when the grammar changes in the zig-spec repo
2018-11-14 07:56:26 +00:00
IDENTIFIER
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
<- !keyword [A-Za-z_] [A-Za-z0-9_]* skip
langref: apply grammar changes This applies the changes to the grammar introduced by the new destructuring syntax, as well as some existing changes which were not copied into the langref.
2023-09-14 23:49:15 +00:00
/ "@" STRINGLITERALSINGLE
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
BUILTINIDENTIFIER <- "@"[A-Za-z_][A-Za-z0-9_]* skip
AMPERSAND <- '&' ![=] skip
AMPERSANDEQUAL <- '&=' skip
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
ASTERISK <- '*' ![*%=|] skip
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
ASTERISK2 <- '**' skip
ASTERISKEQUAL <- '*=' skip
ASTERISKPERCENT <- '*%' ![=] skip
ASTERISKPERCENTEQUAL <- '*%=' skip
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
ASTERISKPIPE <- '*|' ![=] skip
ASTERISKPIPEEQUAL <- '*|=' skip
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
CARET <- '^' ![=] skip
CARETEQUAL <- '^=' skip
COLON <- ':' skip
COMMA <- ',' skip
DOT <- '.' ![*.?] skip
DOT2 <- '..' ![.] skip
DOT3 <- '...' skip
DOTASTERISK <- '.*' skip
DOTQUESTIONMARK <- '.?' skip
EQUAL <- '=' ![>=] skip
EQUALEQUAL <- '==' skip
EQUALRARROW <- '=>' skip
EXCLAMATIONMARK <- '!' ![=] skip
EXCLAMATIONMARKEQUAL <- '!=' skip
LARROW <- '<' ![<=] skip
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
LARROW2 <- '<<' ![=|] skip
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
LARROW2EQUAL <- '<<=' skip
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
LARROW2PIPE <- '<<|' ![=] skip
LARROW2PIPEEQUAL <- '<<|=' skip
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
LARROWEQUAL <- '<=' skip
LBRACE <- '{' skip
LBRACKET <- '[' skip
LPAREN <- '(' skip
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
MINUS <- '-' ![%=>|] skip
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
MINUSEQUAL <- '-=' skip
MINUSPERCENT <- '-%' ![=] skip
MINUSPERCENTEQUAL <- '-%=' skip
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
MINUSPIPE <- '-|' ![=] skip
MINUSPIPEEQUAL <- '-|=' skip
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
MINUSRARROW <- '->' skip
PERCENT <- '%' ![=] skip
PERCENTEQUAL <- '%=' skip
PIPE <- '|' ![|=] skip
PIPE2 <- '||' skip
PIPEEQUAL <- '|=' skip
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
PLUS <- '+' ![%+=|] skip
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
PLUS2 <- '++' skip
PLUSEQUAL <- '+=' skip
PLUSPERCENT <- '+%' ![=] skip
PLUSPERCENTEQUAL <- '+%=' skip
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
PLUSPIPE <- '+|' ![=] skip
PLUSPIPEEQUAL <- '+|=' skip
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
LETTERC <- 'c' skip
QUESTIONMARK <- '?' skip
RARROW <- '>' ![>=] skip
RARROW2 <- '>>' ![=] skip
RARROW2EQUAL <- '>>=' skip
RARROWEQUAL <- '>=' skip
RBRACE <- '}' skip
RBRACKET <- ']' skip
RPAREN <- ')' skip
SEMICOLON <- ';' skip
SLASH <- '/' ![=] skip
SLASHEQUAL <- '/=' skip
TILDE <- '~' skip
end_of_word <- ![a-zA-Z0-9_] skip
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
KEYWORD_addrspace <- 'addrspace' end_of_word
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
KEYWORD_align <- 'align' end_of_word
KEYWORD_allowzero <- 'allowzero' end_of_word
KEYWORD_and <- 'and' end_of_word
KEYWORD_anyframe <- 'anyframe' end_of_word
KEYWORD_anytype <- 'anytype' end_of_word
KEYWORD_asm <- 'asm' end_of_word
KEYWORD_async <- 'async' end_of_word
KEYWORD_await <- 'await' end_of_word
KEYWORD_break <- 'break' end_of_word
KEYWORD_callconv <- 'callconv' end_of_word
KEYWORD_catch <- 'catch' end_of_word
KEYWORD_comptime <- 'comptime' end_of_word
KEYWORD_const <- 'const' end_of_word
KEYWORD_continue <- 'continue' end_of_word
KEYWORD_defer <- 'defer' end_of_word
KEYWORD_else <- 'else' end_of_word
KEYWORD_enum <- 'enum' end_of_word
KEYWORD_errdefer <- 'errdefer' end_of_word
KEYWORD_error <- 'error' end_of_word
KEYWORD_export <- 'export' end_of_word
KEYWORD_extern <- 'extern' end_of_word
KEYWORD_fn <- 'fn' end_of_word
KEYWORD_for <- 'for' end_of_word
KEYWORD_if <- 'if' end_of_word
KEYWORD_inline <- 'inline' end_of_word
KEYWORD_noalias <- 'noalias' end_of_word
KEYWORD_nosuspend <- 'nosuspend' end_of_word
KEYWORD_noinline <- 'noinline' end_of_word
KEYWORD_opaque <- 'opaque' end_of_word
KEYWORD_or <- 'or' end_of_word
KEYWORD_orelse <- 'orelse' end_of_word
KEYWORD_packed <- 'packed' end_of_word
KEYWORD_pub <- 'pub' end_of_word
KEYWORD_resume <- 'resume' end_of_word
KEYWORD_return <- 'return' end_of_word
langref: apply grammar changes This applies the changes to the grammar introduced by the new destructuring syntax, as well as some existing changes which were not copied into the langref.
2023-09-14 23:49:15 +00:00
KEYWORD_linksection <- 'linksection' end_of_word
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
KEYWORD_struct <- 'struct' end_of_word
KEYWORD_suspend <- 'suspend' end_of_word
KEYWORD_switch <- 'switch' end_of_word
KEYWORD_test <- 'test' end_of_word
KEYWORD_threadlocal <- 'threadlocal' end_of_word
KEYWORD_try <- 'try' end_of_word
KEYWORD_union <- 'union' end_of_word
KEYWORD_unreachable <- 'unreachable' end_of_word
KEYWORD_usingnamespace <- 'usingnamespace' end_of_word
KEYWORD_var <- 'var' end_of_word
KEYWORD_volatile <- 'volatile' end_of_word
KEYWORD_while <- 'while' end_of_word
update grammar in langref Closes #14072
2022-12-26 14:35:24 +00:00
keyword <- KEYWORD_addrspace / KEYWORD_align / KEYWORD_allowzero / KEYWORD_and
/ KEYWORD_anyframe / KEYWORD_anytype / KEYWORD_asm / KEYWORD_async
/ KEYWORD_await / KEYWORD_break / KEYWORD_callconv / KEYWORD_catch
/ KEYWORD_comptime / KEYWORD_const / KEYWORD_continue / KEYWORD_defer
/ KEYWORD_else / KEYWORD_enum / KEYWORD_errdefer / KEYWORD_error / KEYWORD_export
stage2: delete keywords `true`, `false`, `undefined`, `null` The grammar does not need these as keywords; they are merely primitives provided by the language the same as `void`, `u32`, etc.
2021-08-28 17:54:14 +00:00
/ KEYWORD_extern / KEYWORD_fn / KEYWORD_for / KEYWORD_if
langref: apply grammar changes This applies the changes to the grammar introduced by the new destructuring syntax, as well as some existing changes which were not copied into the langref.
2023-09-14 23:49:15 +00:00
/ KEYWORD_inline / KEYWORD_noalias / KEYWORD_nosuspend / KEYWORD_noinline
/ KEYWORD_opaque / KEYWORD_or / KEYWORD_orelse / KEYWORD_packed
/ KEYWORD_pub / KEYWORD_resume / KEYWORD_return / KEYWORD_linksection
fix incorrectly escaped html
2021-10-02 20:33:58 +00:00
/ KEYWORD_struct / KEYWORD_suspend / KEYWORD_switch / KEYWORD_test
/ KEYWORD_threadlocal / KEYWORD_try / KEYWORD_union / KEYWORD_unreachable
update grammar in langref
2020-11-22 19:15:12 +00:00
/ KEYWORD_usingnamespace / KEYWORD_var / KEYWORD_volatile / KEYWORD_while
langref: always start code on a separate line in a syntax_block In a syntax_block the code always start on a separate code, expect for C, JavaScript, Peg and with Zig inline assembly. Ensure that the code starts on a separate line, even in cases where there is only one line. Ensure that the end_syntax_block is always on a separate line and that the indentation is consistent.
2023-01-19 11:33:00 +00:00
{#end_syntax_block#}
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
{#header_open|Zen#}
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
<ul>
<li>Communicate intent precisely.</li>
<li>Edge cases matter.</li>
<li>Favor reading code over writing code.</li>
<li>Only one obvious way to do things.</li>
<li>Runtime crashes are better than bugs.</li>
<li>Compile errors are better than runtime crashes.</li>
<li>Incremental improvements.</li>
<li>Avoid local maximums.</li>
<li>Reduce the amount one must remember.</li>
update the zen of zig
2020-09-15 20:40:01 +00:00
<li>Focus on code rather than style.</li>
<li>Resource allocation may fail; resource deallocation must succeed.</li>
<li>Memory is a resource.</li>
zen of zig: reword the last one a little bit
2020-08-31 21:40:08 +00:00
<li>Together we serve the users.</li>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</ul>
docgen auto generates table of contents See #465
2018-01-17 04:19:05 +00:00
{#header_close#}
langref: add appendix and explain 'container' terminology
2022-11-09 08:29:50 +00:00
{#header_close#}
Improve HTML semantics and a11y of language reference The language reference's HTML has been updated to be more semantically correct. This also helps to improve the document's accessibility concerns. * Document structure has single h1, other header sections start at h2, nav sections w/ aria labels, main section * Zig's homepage is linked, Zig Standard Library section link to it * Tables have caption and scoping rows and columns * Code blocks are figures with figure captions citing source files * Change line height 1.5 to include table of contents as well * Luminosity contrast ratios have been adjusted to 7:1 * Dark mode colors adjusted to reduce eye strain * Links have default browser underline with hover and focus effects * Asides, definition lists, keyboard inputs, program outputs are represented semantically Tools used to check: WAVE plugin https://wave.webaim.org/ Firefox Accessibility Developer Tool Lighthouse Accessibility Tool
2021-08-11 09:01:03 +00:00
</main></div>
std.io: introduce buffered I/O and change API I started working on #465 and made some corresponding std.io API changes. New structs: * std.io.FileInStream * std.io.FileOutStream * std.io.BufferedOutStream * std.io.BufferedInStream Removed: * std.io.File.in_stream * std.io.File.out_stream Now instead of &file.out_stream or &file.in_stream to get access to the stream API for a file, you get it like this: var file_in_stream = io.FileInStream.init(&file); const in_stream = &file_in_stream.stream; var file_out_stream = io.FileOutStream.init(&file); const out_stream = &file_out_stream.stream; This is evidence that we might not need any OOP features - See #130.
2017-11-07 08:22:27 +00:00
</div>
</body>
</html>
Reference in New Issue Copy Permalink