mirrors/zig
1
0
Fork 0
mirror of https://codeberg.org/ziglang/zig.git synced 2025-12-06 05:44:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add comment. Split up if docs for optionals.

Browse source
This commit is contained in:
Gordon Cassie 2023-12-07 13:51:03 -08:00
parent cce820f93d
commit ef93a36cd5
1 changed files with 49 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

90
doc/langref.html.in
View file

@ -4628,6 +4628,7 @@ test "while null capture" {
} }
try expect(sum1 == 3); try expect(sum1 == 3);
// null capture with an else block
var sum2: u32 = 0; var sum2: u32 = 0;
numbers_left = 3; numbers_left = 3;
while (eventuallyNullSequence()) |value| { while (eventuallyNullSequence()) |value| {
@ -4636,6 +4637,7 @@ test "while null capture" {
try expect(sum2 == 3); try expect(sum2 == 3);
} }
// null capture with a continue expression
var i: u32 = 0; var i: u32 = 0;
var sum3: u32 = 0; var sum3: u32 = 0;
numbers_left = 3; numbers_left = 3;
@ -4923,46 +4925,6 @@ test "if boolean" {
} }
} }
test "if optional" {
// If expressions test for null.
const a: ?u32 = 0;
if (a) |value| {
try expect(value == 0);
} else {
unreachable;
}
const b: ?u32 = null;
if (b) |_| {
unreachable;
} else {
try expect(true);
}
// The else is not required.
if (a) |value| {
try expect(value == 0);
}
// To test against null only, use the binary equality operator.
if (b == null) {
try expect(true);
}
// Access the value by reference using a pointer capture.
var c: ?u32 = 3;
if (c) |*value| {
value.* = 2;
}
if (c) |value| {
try expect(value == 2);
} else {
unreachable;
}
}
test "if error union" { test "if error union" {
// If expressions test for errors. // If expressions test for errors.
// Note the |err| capture on the else. // Note the |err| capture on the else.
@ -5007,6 +4969,51 @@ test "if error union" {
unreachable; unreachable;
} }
} }
{#code_end#}
{#header_open|if with Optionals#}
{#code_begin|test|test_if_optionals#}
const expect = @import("std").testing.expect;
test "if optional" {
// If expressions test for null.
const a: ?u32 = 0;
if (a) |value| {
try expect(value == 0);
} else {
unreachable;
}
const b: ?u32 = null;
if (b) |_| {
unreachable;
} else {
try expect(true);
}
// The else is not required.
if (a) |value| {
try expect(value == 0);
}
// To test against null only, use the binary equality operator.
if (b == null) {
try expect(true);
}
// Access the value by reference using a pointer capture.
var c: ?u32 = 3;
if (c) |*value| {
value.* = 2;
}
if (c) |value| {
try expect(value == 2);
} else {
unreachable;
}
}
test "if error union with optional" { test "if error union with optional" {
// If expressions test for errors before unwrapping optionals. // If expressions test for errors before unwrapping optionals.
@ -5052,6 +5059,7 @@ test "if error union with optional" {
} }
} }
{#code_end#} {#code_end#}
{#header_close#}
{#see_also|Optionals|Errors#} {#see_also|Optionals|Errors#}
{#header_close#} {#header_close#}
{#header_open|defer#} {#header_open|defer#}
@ -6338,7 +6346,7 @@ test "optional pointers" {
{#code_end#} {#code_end#}
{#header_close#} {#header_close#}
{#see_also|while with Optionals|if#} {#see_also|while with Optionals|if with Optionals#}
{#header_close#} {#header_close#}
{#header_open|Casting#} {#header_open|Casting#}
<p> <p>