Fields
std.Build.Step.InstallDir.base_tag
constant
Step.Tag
std.Build.Step.InstallDir.create
function
pub fn create(owner: *std.Build, options: Options) *InstallDir
Parameters
std.Build.Step.InstallDir.fs
alias
Alias of std.fs
std.Build.Step.InstallDir.InstallDir
alias
Alias of std.Build.Step.InstallDir
std.Build.Step.InstallDir.LazyPath
alias
Alias of std.Build.LazyPath
std.Build.Step.InstallDir.mem
alias
Alias of std.mem
std.Build.Step.InstallDir.Options
container
Fields
source_dir: LazyPath
install_dir: std.Build.InstallDir
install_subdir: []const u8
exclude_extensions: []const []const u8 = &.{}File paths which end in any of these suffixes will be excluded from being installed.
include_extensions: ?[]const []const u8 = nullOnly file paths which end in any of these suffixes will be included
in installation. null means all suffixes are valid for this option.
exclude_extensions take precedence over include_extensions
blank_extensions: []const []const u8 = &.{}File paths which end in any of these suffixes will result in
empty files being installed. This is mainly intended for large
test.zig files in order to prevent needless installation bloat.
However if the files were not present at all, then
@import("test.zig") would be a compile error.
std.Build.Step.InstallDir.Options.dupe
function
fn dupe(opts: Options, graph: *const std.Build.Graph) Options
Parameters
std.Build.Step.InstallDir.std
alias
Alias of std
std.Build.Step.InstallDir.Step
alias
Alias of std.Build.Step
Source code
std/Build/Step/InstallDir.zig
const InstallDir = @This();
const std = @import("std");
const mem = std.mem;
const fs = std.fs;
const Step = std.Build.Step;
const LazyPath = std.Build.LazyPath;
step: Step,
options: Options,
pub const base_tag: Step.Tag = .install_dir;
pub const Options = struct {
source_dir: LazyPath,
install_dir: std.Build.InstallDir,
install_subdir: []const u8,
/// File paths which end in any of these suffixes will be excluded
/// from being installed.
exclude_extensions: []const []const u8 = &.{},
/// Only file paths which end in any of these suffixes will be included
/// in installation. `null` means all suffixes are valid for this option.
/// `exclude_extensions` take precedence over `include_extensions`
include_extensions: ?[]const []const u8 = null,
/// File paths which end in any of these suffixes will result in
/// empty files being installed. This is mainly intended for large
/// test.zig files in order to prevent needless installation bloat.
/// However if the files were not present at all, then
/// `@import("test.zig")` would be a compile error.
blank_extensions: []const []const u8 = &.{},
fn dupe(opts: Options, graph: *const std.Build.Graph) Options {
return .{
.source_dir = opts.source_dir.dupe(graph),
.install_dir = opts.install_dir.dupe(graph),
.install_subdir = graph.dupeString(opts.install_subdir),
.exclude_extensions = graph.dupeStrings(opts.exclude_extensions),
.include_extensions = if (opts.include_extensions) |incs| graph.dupeStrings(incs) else null,
.blank_extensions = graph.dupeStrings(opts.blank_extensions),
};
}
};
pub fn create(owner: *std.Build, options: Options) *InstallDir {
const install_dir = owner.allocator.create(InstallDir) catch @panic("OOM");
const graph = owner.graph;
install_dir.* = .{
.step = Step.init(.{
.tag = base_tag,
.name = owner.fmt("install {f}/", .{options.source_dir}),
.owner = owner,
}),
.options = options.dupe(graph),
};
options.source_dir.addStepDependencies(&install_dir.step);
return install_dir;
}