Skip to content
Standard libraryZig 0.17.0Official documentation
Sourcestd/Build/Step/Fail.zig

Source line 1

Fail the build with a given message.

Fields

step: Step
error_msg: Configuration.String

std.Build.Step.Fail.base_tag

constant

Source line 11

Step.Tag

std.Build.Step.Fail.Configuration

alias

Source line 6

Alias of std.Build.Configuration

std.Build.Step.Fail.create

function

Source line 13

pub fn create(owner: *std.Build, error_msg: []const u8) *Fail

Parameters

owner: *std.Build
error_msg: []const u8

std.Build.Step.Fail.Fail

alias

Source line 2

Alias of std.Build.Step.Fail

std.Build.Step.Fail.std

alias

Source line 4

Alias of std

std.Build.Step.Fail.Step

alias

Source line 5

Alias of std.Build.Step

Source code

std/Build/Step/Fail.zig

//! Fail the build with a given message.
const Fail = @This();

const std = @import("std");
const Step = std.Build.Step;
const Configuration = std.Build.Configuration;

step: Step,
error_msg: Configuration.String,

pub const base_tag: Step.Tag = .fail;

pub fn create(owner: *std.Build, error_msg: []const u8) *Fail {
    const graph = owner.graph;
    const fail = graph.create(Fail);
    fail.* = .{
        .step = .init(.{
            .tag = base_tag,
            .name = "fail",
            .owner = owner,
        }),
        .error_msg = graph.addString(error_msg),
    };
    return fail;
}