Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig standard library. Public Function

expectError

Public Function
std.testing.expectError
pub fn expectError(expected_error: anyerror, actual_error_union: anytype) !void

This function is intended to be used only in tests. When actual_error_union is not expected_error, it prints diagnostics to stderr, then returns a test failure error.

Params

  • expected_error: anyerror
  • actual_error_union

File

testing.zig:628
628
629
630
631
632
633
634
635
636
637
638
639
640
641
pub fn expectError(expected_error: anyerror, actual_error_union: anytype) !void {
    if (actual_error_union) |actual_payload| {
        failPrint("expected error.{s}, found {any}\n", .{ @errorName(expected_error), actual_payload });
        return error.TestExpectedError;
    } else |actual_error| {
        if (expected_error != actual_error) {
            failPrint("expected error.{s}, found error.{s}\n", .{
                @errorName(expected_error),
                @errorName(actual_error),
            });
            return error.TestUnexpectedError;
        }
    }
}