Zig 0.17.0-dev (Split by item)

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 library itself.

expectStdOutEqual

Adds a check for exact stdout match as well as a check for exit code 0, if there is not already an expected termination check.

Run.expectStdOutEqual

pub fn expectStdOutEqual(run: *Run, bytes: []const u8) void

File

lib/std/Build/Step/Run.zig:649

Code

pub fn expectStdOutEqual(run: *Run, bytes: []const u8) void {
    const graph = run.step.owner.graph;
    run.addCheck(.{ .expect_stdout_exact = graph.dupeString(bytes) });
    if (!run.hasTermCheck()) run.expectExitCode(0);
}