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

expect

Public Function
std.testing.expect
pub fn expect(ok: bool) !void

This function is intended to be used only in tests. When ok is false, returns a test failure error.

Params

  • ok: bool

File

testing.zig:583
583
584
585
pub fn expect(ok: bool) !void {
    if (!ok) return error.TestUnexpectedResult;
}