Fail the build step if a file does not match certain checks.
Fields
step: Step
file: std.Build.LazyPath
expected_matches: []const Configuration.Bytes
expected_exact: ?Configuration.Bytes
max_bytes: ?u32
std.Build.Step.CheckFile.base_tag
constant
Step.Tag
std.Build.Step.CheckFile.CheckFile
alias
Alias of std.Build.Step.CheckFile
std.Build.Step.CheckFile.Configuration
alias
Alias of std.Build.Configuration
std.Build.Step.CheckFile.create
function
pub fn create(owner: *std.Build, file: std.Build.LazyPath, options: Options) *CheckFile
Parameters
std.Build.Step.CheckFile.fs
alias
Alias of std.fs
std.Build.Step.CheckFile.Io
alias
Alias of std.Io
std.Build.Step.CheckFile.mem
alias
Alias of std.mem
std.Build.Step.CheckFile.Options
container
Fields
expected_matches: []const []const u8 = &.{}
expected_exact: ?[]const u8 = null
max_bytes: ?u32 = null
std.Build.Step.CheckFile.setName
function
pub fn setName(check_file: *CheckFile, name: []const u8) void
Parameters
check_file: *CheckFile
name: []const u8
std.Build.Step.CheckFile.std
alias
Alias of std
std.Build.Step.CheckFile.Step
alias
Alias of std.Build.Step
Source code
std/Build/Step/CheckFile.zig
//! Fail the build step if a file does not match certain checks.
const CheckFile = @This();
const std = @import("std");
const Io = std.Io;
const Step = std.Build.Step;
const fs = std.fs;
const mem = std.mem;
const Configuration = std.Build.Configuration;
step: Step,
file: std.Build.LazyPath,
expected_matches: []const Configuration.Bytes,
expected_exact: ?Configuration.Bytes,
max_bytes: ?u32,
pub const base_tag: Step.Tag = .check_file;
pub const Options = struct {
expected_matches: []const []const u8 = &.{},
expected_exact: ?[]const u8 = null,
max_bytes: ?u32 = null,
};
pub fn create(owner: *std.Build, file: std.Build.LazyPath, options: Options) *CheckFile {
const graph = owner.graph;
const check_file = graph.create(CheckFile);
check_file.* = .{
.step = .init(.{
.tag = base_tag,
.name = "CheckFile",
.owner = owner,
}),
.file = file.dupe(graph),
.expected_matches = graph.addBytesList(options.expected_matches),
.expected_exact = if (options.expected_exact) |b| graph.addBytes(b) else null,
.max_bytes = options.max_bytes,
};
file.addStepDependencies(&check_file.step);
return check_file;
}
pub fn setName(check_file: *CheckFile, name: []const u8) void {
check_file.step.name = check_file.step.owner.graph.dupeString(name);
}