| ... | ... | @@ -1290,13 +1290,39 @@ test "expectError demo" { |
| 1290 | 1290 | A variable is a unit of {#link|Memory#} storage. |
| 1291 | 1291 | </p> |
| 1292 | 1292 | <p> |
| 1293 | | Variables are never allowed to shadow identifiers from an outer scope. |
| 1294 | | </p> |
| 1295 | | <p> |
| 1296 | 1293 | It is generally preferable to use {#syntax#}const{#endsyntax#} rather than |
| 1297 | 1294 | {#syntax#}var{#endsyntax#} when declaring a variable. This causes less work for both |
| 1298 | 1295 | humans and computers to do when reading code, and creates more optimization opportunities. |
| 1299 | 1296 | </p> |
| 1297 | |
| 1298 | {#header_open|Identifiers#} |
| 1299 | <p> |
| 1300 | Variable identifiers are never allowed to shadow identifiers from an outer scope. |
| 1301 | </p> |
| 1302 | <p> |
| 1303 | Identifiers must start with an alphabetic character or underscore and may be followed |
| 1304 | by any number of alphanumeric characters or underscores. |
| 1305 | They must not overlap with any keywords. See {#link|Keyword Reference#}. |
| 1306 | </p> |
| 1307 | <p> |
| 1308 | 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. |
| 1309 | </p> |
| 1310 | {#code_begin|syntax#} |
| 1311 | const @"identifier with spaces in it" = 0xff; |
| 1312 | const @"1SmallStep4Man" = 112358; |
| 1313 | |
| 1314 | const c = @import("std").c; |
| 1315 | pub extern "c" fn @"error"() anyopaque; |
| 1316 | pub extern "c" fn @"fstat$INODE64"(fd: c.fd_t, buf: *c.Stat) c_int; |
| 1317 | |
| 1318 | const Color = enum { |
| 1319 | red, |
| 1320 | @"really red", |
| 1321 | }; |
| 1322 | const color: Color = .@"really red"; |
| 1323 | {#code_end#} |
| 1324 | {#header_close#} |
| 1325 | |
| 1300 | 1326 | {#header_open|Container Level Variables#} |
| 1301 | 1327 | <p> |
| 1302 | 1328 | Container level variables have static lifetime and are order-independent and lazily analyzed. |
| ... | ... | @@ -1481,7 +1507,7 @@ fn divide(a: i32, b: i32) i32 { |
| 1481 | 1507 | </p> |
| 1482 | 1508 | <p> |
| 1483 | 1509 | Operators such as {#syntax#}+{#endsyntax#} and {#syntax#}-{#endsyntax#} cause undefined behavior on |
| 1484 | | integer overflow. Alternative operators are provided for wrapping and saturating arithmetic on all targets. |
| 1510 | integer overflow. Alternative operators are provided for wrapping and saturating arithmetic on all targets. |
| 1485 | 1511 | {#syntax#}+%{#endsyntax#} and {#syntax#}-%{#endsyntax#} perform wrapping arithmetic |
| 1486 | 1512 | while {#syntax#}+|{#endsyntax#} and {#syntax#}-|{#endsyntax#} perform saturating arithmetic. |
| 1487 | 1513 | </p> |
| ... | ... | @@ -2488,32 +2514,32 @@ test "null terminated array" { |
| 2488 | 2514 | or using the shorthand function {#syntax#}std.meta.Vector{#endsyntax#}. |
| 2489 | 2515 | </p> |
| 2490 | 2516 | <p> |
| 2491 | | Vectors support the same builtin operators as their underlying base types. These operations are performed |
| 2517 | Vectors support the same builtin operators as their underlying base types. These operations are performed |
| 2492 | 2518 | element-wise, and return a vector of the same length as the input vectors. This includes: |
| 2493 | 2519 | </p> |
| 2494 | 2520 | <ul> |
| 2495 | | <li>Arithmetic ({#syntax#}+{#endsyntax#}, {#syntax#}-{#endsyntax#}, {#syntax#}/{#endsyntax#}, {#syntax#}*{#endsyntax#}, |
| 2496 | | {#syntax#}@divFloor{#endsyntax#}, {#syntax#}@sqrt{#endsyntax#}, {#syntax#}@ceil{#endsyntax#}, |
| 2521 | <li>Arithmetic ({#syntax#}+{#endsyntax#}, {#syntax#}-{#endsyntax#}, {#syntax#}/{#endsyntax#}, {#syntax#}*{#endsyntax#}, |
| 2522 | {#syntax#}@divFloor{#endsyntax#}, {#syntax#}@sqrt{#endsyntax#}, {#syntax#}@ceil{#endsyntax#}, |
| 2497 | 2523 | {#syntax#}@log{#endsyntax#}, etc.)</li> |
| 2498 | | <li>Bitwise operators ({#syntax#}>>{#endsyntax#}, {#syntax#}<<{#endsyntax#}, {#syntax#}&{#endsyntax#}, |
| 2524 | <li>Bitwise operators ({#syntax#}>>{#endsyntax#}, {#syntax#}<<{#endsyntax#}, {#syntax#}&{#endsyntax#}, |
| 2499 | 2525 | {#syntax#}|{#endsyntax#}, {#syntax#}~{#endsyntax#}, etc.)</li> |
| 2500 | 2526 | <li>Comparison operators ({#syntax#}<{#endsyntax#}, {#syntax#}>{#endsyntax#}, {#syntax#}=={#endsyntax#}, etc.)</li> |
| 2501 | 2527 | </ul> |
| 2502 | 2528 | <p> |
| 2503 | | It is prohibited to use a math operator on a mixture of scalars (individual numbers) and vectors. |
| 2504 | | Zig provides the {#link|@splat#} builtin to easily convert from scalars to vectors, and it supports {#link|@reduce#} |
| 2505 | | and array indexing syntax to convert from vectors to scalars. Vectors also support assignment to and from |
| 2529 | It is prohibited to use a math operator on a mixture of scalars (individual numbers) and vectors. |
| 2530 | Zig provides the {#link|@splat#} builtin to easily convert from scalars to vectors, and it supports {#link|@reduce#} |
| 2531 | and array indexing syntax to convert from vectors to scalars. Vectors also support assignment to and from |
| 2506 | 2532 | fixed-length arrays with comptime known length. |
| 2507 | 2533 | </p> |
| 2508 | 2534 | <p> |
| 2509 | 2535 | For rearranging elements within and between vectors, Zig provides the {#link|@shuffle#} and {#link|@select#} functions. |
| 2510 | 2536 | </p> |
| 2511 | 2537 | <p> |
| 2512 | | Operations on vectors shorter than the target machine's native SIMD size will typically compile to single SIMD |
| 2513 | | instructions, while vectors longer than the target machine's native SIMD size will compile to multiple SIMD |
| 2514 | | instructions. If a given operation doesn't have SIMD support on the target architecture, the compiler will default |
| 2515 | | to operating on each vector element one at a time. Zig supports any comptime-known vector length up to 2^32-1, |
| 2516 | | although small powers of two (2-64) are most typical. Note that excessively long vector lengths (e.g. 2^20) may |
| 2538 | Operations on vectors shorter than the target machine's native SIMD size will typically compile to single SIMD |
| 2539 | instructions, while vectors longer than the target machine's native SIMD size will compile to multiple SIMD |
| 2540 | instructions. If a given operation doesn't have SIMD support on the target architecture, the compiler will default |
| 2541 | to operating on each vector element one at a time. Zig supports any comptime-known vector length up to 2^32-1, |
| 2542 | although small powers of two (2-64) are most typical. Note that excessively long vector lengths (e.g. 2^20) may |
| 2517 | 2543 | result in compiler crashes on current versions of Zig. |
| 2518 | 2544 | </p> |
| 2519 | 2545 | {#code_begin|test|vector_example#} |
| ... | ... | @@ -2563,7 +2589,7 @@ test "Conversion between vectors, arrays, and slices" { |
| 2563 | 2589 | TODO consider suggesting std.MultiArrayList |
| 2564 | 2590 | </p> |
| 2565 | 2591 | {#see_also|@splat|@shuffle|@select|@reduce#} |
| 2566 | | |
| 2592 | |
| 2567 | 2593 | {#header_close#} |
| 2568 | 2594 | |
| 2569 | 2595 | {#header_open|Pointers#} |
| ... | ... | @@ -2981,8 +3007,8 @@ test "null terminated slice" { |
| 2981 | 3007 | } |
| 2982 | 3008 | {#code_end#} |
| 2983 | 3009 | <p> |
| 2984 | | Sentinel-terminated slices can also be created using a variation of the slice syntax |
| 2985 | | {#syntax#}data[start..end :x]{#endsyntax#}, where {#syntax#}data{#endsyntax#} is a many-item pointer, |
| 3010 | Sentinel-terminated slices can also be created using a variation of the slice syntax |
| 3011 | {#syntax#}data[start..end :x]{#endsyntax#}, where {#syntax#}data{#endsyntax#} is a many-item pointer, |
| 2986 | 3012 | array or slice and {#syntax#}x{#endsyntax#} is the sentinel value. |
| 2987 | 3013 | </p> |
| 2988 | 3014 | {#code_begin|test|null_terminated_slicing#} |
| ... | ... | @@ -2999,7 +3025,7 @@ test "null terminated slicing" { |
| 2999 | 3025 | } |
| 3000 | 3026 | {#code_end#} |
| 3001 | 3027 | <p> |
| 3002 | | Sentinel-terminated slicing asserts that the element in the sentinel position of the backing data is |
| 3028 | Sentinel-terminated slicing asserts that the element in the sentinel position of the backing data is |
| 3003 | 3029 | actually the sentinel value. If this is not the case, safety-protected {#link|Undefined Behavior#} results. |
| 3004 | 3030 | </p> |
| 3005 | 3031 | {#code_begin|test_safety|sentinel mismatch#} |
| ... | ... | @@ -3008,10 +3034,10 @@ const expect = std.testing.expect; |
| 3008 | 3034 | |
| 3009 | 3035 | test "sentinel mismatch" { |
| 3010 | 3036 | var array = [_]u8{ 3, 2, 1, 0 }; |
| 3011 | | |
| 3012 | | // Creating a sentinel-terminated slice from the array with a length of 2 |
| 3013 | | // will result in the value `1` occupying the sentinel element position. |
| 3014 | | // This does not match the indicated sentinel value of `0` and will lead |
| 3037 | |
| 3038 | // Creating a sentinel-terminated slice from the array with a length of 2 |
| 3039 | // will result in the value `1` occupying the sentinel element position. |
| 3040 | // This does not match the indicated sentinel value of `0` and will lead |
| 3015 | 3041 | // to a runtime panic. |
| 3016 | 3042 | var runtime_length: usize = 2; |
| 3017 | 3043 | const slice = array[0..runtime_length :0]; |
| ... | ... | @@ -3159,7 +3185,7 @@ test "linked list" { |
| 3159 | 3185 | .last = &node, |
| 3160 | 3186 | .len = 1, |
| 3161 | 3187 | }; |
| 3162 | | |
| 3188 | |
| 3163 | 3189 | // When using a pointer to a struct, fields can be accessed directly, |
| 3164 | 3190 | // without explicitly dereferencing the pointer. |
| 3165 | 3191 | // So you can do |
| ... | ... | @@ -3491,7 +3517,7 @@ fn dump(args: anytype) !void { |
| 3491 | 3517 | </p> |
| 3492 | 3518 | <p> |
| 3493 | 3519 | The fields are implicitly named using numbers starting from 0. Because their names are integers, |
| 3494 | | the {#syntax#}@"0"{#endsyntax#} syntax must be used to access them. Names inside {#syntax#}@""{#endsyntax#} are always recognised as identifiers. |
| 3520 | the {#syntax#}@"0"{#endsyntax#} syntax must be used to access them. Names inside {#syntax#}@""{#endsyntax#} are always recognised as {#link|identifiers|Identifiers#}. |
| 3495 | 3521 | </p> |
| 3496 | 3522 | <p> |
| 3497 | 3523 | Like arrays, tuples have a .len field, can be indexed and work with the ++ and ** operators. They can also be iterated over with {#link|inline for#}. |
| ... | ... | @@ -3980,7 +4006,7 @@ test "labeled break from labeled block expression" { |
| 3980 | 4006 | {#see_also|Labeled while|Labeled for#} |
| 3981 | 4007 | |
| 3982 | 4008 | {#header_open|Shadowing#} |
| 3983 | | <p>Identifiers are never allowed to "hide" other identifiers by using the same name:</p> |
| 4009 | <p>{#link|Identifiers#} are never allowed to "hide" other identifiers by using the same name:</p> |
| 3984 | 4010 | {#code_begin|test_err|local shadows declaration#} |
| 3985 | 4011 | const pi = 3.14; |
| 3986 | 4012 | |
| ... | ... | @@ -3992,8 +4018,8 @@ test "inside test block" { |
| 3992 | 4018 | } |
| 3993 | 4019 | {#code_end#} |
| 3994 | 4020 | <p> |
| 3995 | | Because of this, when you read Zig code you can always rely on an identifier to consistently mean |
| 3996 | | the same thing within the scope it is defined. Note that you can, however, use the same name if |
| 4021 | Because of this, when you read Zig code you can always rely on an identifier to consistently mean |
| 4022 | the same thing within the scope it is defined. Note that you can, however, use the same name if |
| 3997 | 4023 | the scopes are separate: |
| 3998 | 4024 | </p> |
| 3999 | 4025 | {#code_begin|test|test_scopes#} |
| ... | ... | @@ -4031,7 +4057,7 @@ test "switch simple" { |
| 4031 | 4057 | 1, 2, 3 => 0, |
| 4032 | 4058 | |
| 4033 | 4059 | // Ranges can be specified using the ... syntax. These are inclusive |
| 4034 | | // both ends. |
| 4060 | // of both ends. |
| 4035 | 4061 | 5...100 => 1, |
| 4036 | 4062 | |
| 4037 | 4063 | // Branches can be arbitrarily complex. |
| ... | ... | @@ -4803,7 +4829,7 @@ test "errdefer unwinding" { |
| 4803 | 4829 | </p> |
| 4804 | 4830 | {#header_open|Basics#} |
| 4805 | 4831 | {#code_begin|test|test_unreachable#} |
| 4806 | | // unreachable is used to assert that control flow will never happen upon a |
| 4832 | // unreachable is used to assert that control flow will never reach a |
| 4807 | 4833 | // particular location: |
| 4808 | 4834 | test "basic math" { |
| 4809 | 4835 | const x = 1; |
| ... | ... | @@ -6771,8 +6797,7 @@ test "variable values" { |
| 6771 | 6797 | generic data structure. |
| 6772 | 6798 | </p> |
| 6773 | 6799 | <p> |
| 6774 | | Here is an example of a generic {#syntax#}List{#endsyntax#} data structure, that we will instantiate with |
| 6775 | | the type {#syntax#}i32{#endsyntax#}. In Zig we refer to the type as {#syntax#}List(i32){#endsyntax#}. |
| 6800 | Here is an example of a generic {#syntax#}List{#endsyntax#} data structure. |
| 6776 | 6801 | </p> |
| 6777 | 6802 | {#code_begin|syntax#} |
| 6778 | 6803 | fn List(comptime T: type) type { |
| ... | ... | @@ -6781,27 +6806,46 @@ fn List(comptime T: type) type { |
| 6781 | 6806 | len: usize, |
| 6782 | 6807 | }; |
| 6783 | 6808 | } |
| 6809 | |
| 6810 | // The generic List data structure can be instantiated by passing in a type: |
| 6811 | var buffer: [10]i32 = undefined; |
| 6812 | var list = List(i32){ |
| 6813 | .items = &buffer, |
| 6814 | .len = 0, |
| 6815 | }; |
| 6784 | 6816 | {#code_end#} |
| 6785 | 6817 | <p> |
| 6786 | | That's it. It's a function that returns an anonymous {#syntax#}struct{#endsyntax#}. For the purposes of error messages |
| 6787 | | and debugging, Zig infers the name {#syntax#}"List(i32)"{#endsyntax#} from the function name and parameters invoked when creating |
| 6818 | That's it. It's a function that returns an anonymous {#syntax#}struct{#endsyntax#}. |
| 6819 | To keep the language small and uniform, all aggregate types in Zig are anonymous. |
| 6820 | For the purposes of error messages and debugging, Zig infers the name |
| 6821 | {#syntax#}"List(i32)"{#endsyntax#} from the function name and parameters invoked when creating |
| 6788 | 6822 | the anonymous struct. |
| 6789 | 6823 | </p> |
| 6790 | 6824 | <p> |
| 6791 | | To keep the language small and uniform, all aggregate types in Zig are anonymous. To give a type |
| 6792 | | a name, we assign it to a constant: |
| 6825 | To explicitly give a type a name, we assign it to a constant. |
| 6793 | 6826 | </p> |
| 6794 | 6827 | {#code_begin|syntax#} |
| 6795 | 6828 | const Node = struct { |
| 6796 | | next: *Node, |
| 6797 | | name: []u8, |
| 6829 | next: ?*Node, |
| 6830 | name: []const u8, |
| 6831 | }; |
| 6832 | |
| 6833 | var node_a = Node{ |
| 6834 | .next = null, |
| 6835 | .name = &"Node A", |
| 6836 | }; |
| 6837 | |
| 6838 | var node_b = Node{ |
| 6839 | .next = &node_a, |
| 6840 | .name = &"Node B", |
| 6798 | 6841 | }; |
| 6799 | 6842 | {#code_end#} |
| 6800 | 6843 | <p> |
| 6801 | | This works because all top level declarations are order-independent, and as long as there isn't |
| 6802 | | an actual infinite regression, values can refer to themselves, directly or indirectly. In this case, |
| 6803 | | {#syntax#}Node{#endsyntax#} refers to itself as a pointer, which is not actually an infinite regression, so |
| 6804 | | it works fine. |
| 6844 | In this example, the {#syntax#}Node{#endsyntax#} struct refers to itself. |
| 6845 | This works because all top level declarations are order-independent. |
| 6846 | As long as the compiler can determine the size of the struct, it is free to refer to itself. |
| 6847 | In this case, {#syntax#}Node{#endsyntax#} refers to itself as a pointer, which has a |
| 6848 | well-defined size at compile time, so it works fine. |
| 6805 | 6849 | </p> |
| 6806 | 6850 | {#header_close#} |
| 6807 | 6851 | {#header_open|Case Study: print in Zig#} |
| ... | ... | @@ -7214,10 +7258,10 @@ test "global assembly" { |
| 7214 | 7258 | provided explicitly by the caller, and it can be suspended and resumed any number of times. |
| 7215 | 7259 | </p> |
| 7216 | 7260 | <p> |
| 7217 | | The code following the {#syntax#}async{#endsyntax#} callsite runs immediately after the async |
| 7218 | | function first suspends. When the return value of the async function is needed, |
| 7219 | | the calling code can {#syntax#}await{#endsyntax#} on the async function frame. |
| 7220 | | This will suspend the calling code until the async function completes, at which point |
| 7261 | The code following the {#syntax#}async{#endsyntax#} callsite runs immediately after the async |
| 7262 | function first suspends. When the return value of the async function is needed, |
| 7263 | the calling code can {#syntax#}await{#endsyntax#} on the async function frame. |
| 7264 | This will suspend the calling code until the async function completes, at which point |
| 7221 | 7265 | execution resumes just after the {#syntax#}await{#endsyntax#} callsite. |
| 7222 | 7266 | </p> |
| 7223 | 7267 | <p> |
| ... | ... | @@ -7327,8 +7371,8 @@ fn testResumeFromSuspend(my_result: *i32) void { |
| 7327 | 7371 | in standard code. |
| 7328 | 7372 | </p> |
| 7329 | 7373 | <p> |
| 7330 | | However, it is possible to have an {#syntax#}async{#endsyntax#} call |
| 7331 | | without a matching {#syntax#}await{#endsyntax#}. Upon completion of the async function, |
| 7374 | However, it is possible to have an {#syntax#}async{#endsyntax#} call |
| 7375 | without a matching {#syntax#}await{#endsyntax#}. Upon completion of the async function, |
| 7332 | 7376 | execution would continue at the most recent {#syntax#}async{#endsyntax#} callsite or {#syntax#}resume{#endsyntax#} callsite, |
| 7333 | 7377 | and the return value of the async function would be lost. |
| 7334 | 7378 | </p> |
| ... | ... | @@ -7365,8 +7409,8 @@ fn func() void { |
| 7365 | 7409 | </p> |
| 7366 | 7410 | <p> |
| 7367 | 7411 | {#syntax#}await{#endsyntax#} is a suspend point, and takes as an operand anything that |
| 7368 | | coerces to {#syntax#}anyframe->T{#endsyntax#}. Calling {#syntax#}await{#endsyntax#} on |
| 7369 | | the frame of an async function will cause execution to continue at the |
| 7412 | coerces to {#syntax#}anyframe->T{#endsyntax#}. Calling {#syntax#}await{#endsyntax#} on |
| 7413 | the frame of an async function will cause execution to continue at the |
| 7370 | 7414 | {#syntax#}await{#endsyntax#} callsite once the target function completes. |
| 7371 | 7415 | </p> |
| 7372 | 7416 | <p> |
| ... | ... | @@ -8291,8 +8335,8 @@ fn internalName() callconv(.C) void {} |
| 8291 | 8335 | {#code_begin|obj#} |
| 8292 | 8336 | export fn foo() void {} |
| 8293 | 8337 | {#code_end#} |
| 8294 | | <p>Note that even when using {#syntax#}export{#endsyntax#}, {#syntax#}@"foo"{#endsyntax#} syntax can |
| 8295 | | be used to choose any string for the symbol name:</p> |
| 8338 | <p>Note that even when using {#syntax#}export{#endsyntax#}, the {#syntax#}@"foo"{#endsyntax#} syntax for |
| 8339 | {#link|identifiers|Identifiers#} can be used to choose any string for the symbol name:</p> |
| 8296 | 8340 | {#code_begin|obj#} |
| 8297 | 8341 | export fn @"A function name that is a complete sentence."() void {} |
| 8298 | 8342 | {#code_end#} |
| ... | ... | @@ -8591,7 +8635,9 @@ test "integer cast panic" { |
| 8591 | 8635 | {#header_open|@intToPtr#} |
| 8592 | 8636 | <pre>{#syntax#}@intToPtr(comptime DestType: type, address: usize) DestType{#endsyntax#}</pre> |
| 8593 | 8637 | <p> |
| 8594 | | Converts an integer to a {#link|pointer|Pointers#}. To convert the other way, use {#link|@ptrToInt#}. |
| 8638 | Converts an integer to a {#link|pointer|Pointers#}. To convert the other way, use {#link|@ptrToInt#}. Casting an address of 0 to a destination type |
| 8639 | which in not {#link|optional|Optional Pointers#} and does not have the {#syntax#}allowzero{#endsyntax#} attribute will result in a |
| 8640 | {#link|Pointer Cast Invalid Null#} panic when runtime safety checks are enabled. |
| 8595 | 8641 | </p> |
| 8596 | 8642 | <p> |
| 8597 | 8643 | If the destination pointer type does not allow address zero and {#syntax#}address{#endsyntax#} |
| ... | ... | @@ -8705,7 +8751,8 @@ test "@wasmMemoryGrow" { |
| 8705 | 8751 | <pre>{#syntax#}@mod(numerator: T, denominator: T) T{#endsyntax#}</pre> |
| 8706 | 8752 | <p> |
| 8707 | 8753 | Modulus division. For unsigned integers this is the same as |
| 8708 | | {#syntax#}numerator % denominator{#endsyntax#}. Caller guarantees {#syntax#}denominator > 0{#endsyntax#}. |
| 8754 | {#syntax#}numerator % denominator{#endsyntax#}. Caller guarantees {#syntax#}denominator > 0{#endsyntax#}, otherwise the |
| 8755 | operation will result in a {#link|Remainder Division by Zero#} when runtime safety checks are enabled. |
| 8709 | 8756 | </p> |
| 8710 | 8757 | <ul> |
| 8711 | 8758 | <li>{#syntax#}@mod(-5, 3) == 1{#endsyntax#}</li> |
| ... | ... | @@ -8723,7 +8770,7 @@ test "@wasmMemoryGrow" { |
| 8723 | 8770 | If no overflow or underflow occurs, returns {#syntax#}false{#endsyntax#}. |
| 8724 | 8771 | </p> |
| 8725 | 8772 | {#header_close#} |
| 8726 | | |
| 8773 | |
| 8727 | 8774 | {#header_open|@panic#} |
| 8728 | 8775 | <pre>{#syntax#}@panic(message: []const u8) noreturn{#endsyntax#}</pre> |
| 8729 | 8776 | <p> |
| ... | ... | @@ -8830,7 +8877,8 @@ pub const PrefetchOptions = struct { |
| 8830 | 8877 | <pre>{#syntax#}@rem(numerator: T, denominator: T) T{#endsyntax#}</pre> |
| 8831 | 8878 | <p> |
| 8832 | 8879 | Remainder division. For unsigned integers this is the same as |
| 8833 | | {#syntax#}numerator % denominator{#endsyntax#}. Caller guarantees {#syntax#}denominator > 0{#endsyntax#}. |
| 8880 | {#syntax#}numerator % denominator{#endsyntax#}. Caller guarantees {#syntax#}denominator > 0{#endsyntax#}, otherwise the |
| 8881 | operation will result in a {#link|Remainder Division by Zero#} when runtime safety checks are enabled. |
| 8834 | 8882 | </p> |
| 8835 | 8883 | <ul> |
| 8836 | 8884 | <li>{#syntax#}@rem(-5, 3) == -2{#endsyntax#}</li> |
| ... | ... | @@ -8872,14 +8920,14 @@ pub const PrefetchOptions = struct { |
| 8872 | 8920 | {#header_close#} |
| 8873 | 8921 | |
| 8874 | 8922 | {#header_open|@setCold#} |
| 8875 | | <pre>{#syntax#}@setCold(is_cold: bool){#endsyntax#}</pre> |
| 8923 | <pre>{#syntax#}@setCold(comptime is_cold: bool){#endsyntax#}</pre> |
| 8876 | 8924 | <p> |
| 8877 | 8925 | Tells the optimizer that a function is rarely called. |
| 8878 | 8926 | </p> |
| 8879 | 8927 | {#header_close#} |
| 8880 | 8928 | |
| 8881 | 8929 | {#header_open|@setEvalBranchQuota#} |
| 8882 | | <pre>{#syntax#}@setEvalBranchQuota(new_quota: u32){#endsyntax#}</pre> |
| 8930 | <pre>{#syntax#}@setEvalBranchQuota(comptime new_quota: u32){#endsyntax#}</pre> |
| 8883 | 8931 | <p> |
| 8884 | 8932 | Changes the maximum number of backwards branches that compile-time code |
| 8885 | 8933 | execution can use before giving up and making a compile error. |
| ... | ... | @@ -8914,7 +8962,7 @@ test "foo" { |
| 8914 | 8962 | {#header_close#} |
| 8915 | 8963 | |
| 8916 | 8964 | {#header_open|@setFloatMode#} |
| 8917 | | <pre>{#syntax#}@setFloatMode(mode: @import("std").builtin.FloatMode){#endsyntax#}</pre> |
| 8965 | <pre>{#syntax#}@setFloatMode(comptime mode: @import("std").builtin.FloatMode){#endsyntax#}</pre> |
| 8918 | 8966 | <p> |
| 8919 | 8967 | Sets the floating point mode of the current scope. Possible values are: |
| 8920 | 8968 | </p> |
| ... | ... | @@ -8949,7 +8997,7 @@ pub const FloatMode = enum { |
| 8949 | 8997 | {#header_close#} |
| 8950 | 8998 | |
| 8951 | 8999 | {#header_open|@setRuntimeSafety#} |
| 8952 | | <pre>{#syntax#}@setRuntimeSafety(safety_on: bool) void{#endsyntax#}</pre> |
| 9000 | <pre>{#syntax#}@setRuntimeSafety(comptime safety_on: bool) void{#endsyntax#}</pre> |
| 8953 | 9001 | <p> |
| 8954 | 9002 | Sets whether runtime safety checks are enabled for the scope that contains the function call. |
| 8955 | 9003 | </p> |
| ... | ... | @@ -9010,7 +9058,7 @@ test "@setRuntimeSafety" { |
| 9010 | 9058 | </p> |
| 9011 | 9059 | {#see_also|@shlExact|@shrExact#} |
| 9012 | 9060 | {#header_close#} |
| 9013 | | |
| 9061 | |
| 9014 | 9062 | {#header_open|@shrExact#} |
| 9015 | 9063 | <pre>{#syntax#}@shrExact(value: T, shift_amt: Log2T) T{#endsyntax#}</pre> |
| 9016 | 9064 | <p> |
| ... | ... | @@ -9341,7 +9389,7 @@ fn doTheTest() !void { |
| 9341 | 9389 | If no overflow or underflow occurs, returns {#syntax#}false{#endsyntax#}. |
| 9342 | 9390 | </p> |
| 9343 | 9391 | {#header_close#} |
| 9344 | | |
| 9392 | |
| 9345 | 9393 | {#header_open|@tagName#} |
| 9346 | 9394 | <pre>{#syntax#}@tagName(value: anytype) [:0]const u8{#endsyntax#}</pre> |
| 9347 | 9395 | <p> |
Kirk Scheibelhut <scheibo@users.noreply.github.com> 2022-02-04 11:27:50-08:00
Andrew Kelley <andrew@ziglang.org> 2022-02-07 12:22:06-07:00