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 Struct

InstallFile

Public Struct

Fields

step: Step
source: LazyPath
dir: InstallDir
dest_rel_path: []const u8

Namespaces

Values

Functions

pub fn create(owner: *std.Build, source: LazyPath, dir: InstallDir, dest_rel_path: []const u8) *InstallFile

File

Build/Step/InstallFile.zig
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
const InstallFile = @This();

const std = @import("std");
const Step = std.Build.Step;
const LazyPath = std.Build.LazyPath;
const InstallDir = std.Build.InstallDir;
const assert = std.debug.assert;

step: Step,
source: LazyPath,
dir: InstallDir,
dest_rel_path: []const u8,

pub const base_tag: Step.Tag = .install_file;

pub fn create(
    owner: *std.Build,
    source: LazyPath,
    dir: InstallDir,
    dest_rel_path: []const u8,
) *InstallFile {
    assert(dest_rel_path.len != 0);
    const graph = owner.graph;
    const arena = graph.arena;
    const install_file = arena.create(InstallFile) catch @panic("OOM");
    install_file.* = .{
        .step = Step.init(.{
            .tag = base_tag,
            .name = owner.fmt("install {f} to {s}", .{ source, dest_rel_path }),
            .owner = owner,
        }),
        .source = source.dupe(graph),
        .dir = dir.dupe(graph),
        .dest_rel_path = graph.dupePath(dest_rel_path),
    };
    source.addStepDependencies(&install_file.step);
    return install_file;
}