Nixyri/zig
1
0
Fork 0
mirror of https://github.com/ziglang/zig.git synced 2024-12-02 17:20:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

langref: improve the defer section

Browse Source 
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`.
This commit is contained in:
Manlio Perillo 2022-12-11 17:40:36 +01:00 committed by Andrew Kelley
parent e0ba8b8ae5
commit 09cc6b4b9e
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/langref.html.in
View File

@ -4959,6 +4959,20 @@ fn deferUnwindExample() void {
test "defer unwinding" {
deferUnwindExample();
}
{#code_end#}
{#code_begin|test_err|cannot return from defer expression#}
// Inside a defer expression the return statement is not allowed.
fn deferInvalidExample() !void {
defer {
return error.DeferError;
}
return error.DeferError;
}
{#code_end#}
{#code_begin|test|errdefer#}
const std = @import("std");
const print = std.debug.print;
// The errdefer keyword is similar to defer, but will only execute if the
// scope returns with an error.
@ -4977,19 +4991,6 @@ fn deferErrorExample(is_error: bool) !void {
print("encountered an error!\n", .{});
}
// inside a defer method the return statement
// is not allowed.
// The following lines produce the following
// error if uncomment
// ```
// defer.zig:73:9: error: cannot return from defer expression
// return error.DeferError;
// ```
//
//defer {
// return error.DeferError;
//}
if (is_error) {
return error.DeferError;
}