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

Options

Public Struct
std.Build.Step.Compile.HeaderInstallation.Directory.Options
pub const Options = struct

Fields

exclude_extensions: []const []const u8 = &.{}

File paths that end in any of these suffixes will be excluded from installation.

include_extensions: ?[]const []const u8 = &.{".h"}

Only file paths that end in any of these suffixes will be included in installation. null means that all suffixes will be included. exclude_extensions takes precedence over include_extensions.

Functions

pub fn dupe(opts: Directory.Options, graph: *const std.Build.Graph) Directory.Options

File

Build/Step/Compile.zig:323
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
        pub const Options = struct {
            /// File paths that end in any of these suffixes will be excluded from installation.
            exclude_extensions: []const []const u8 = &.{},
            /// Only file paths that end in any of these suffixes will be included in installation.
            /// `null` means that all suffixes will be included.
            /// `exclude_extensions` takes precedence over `include_extensions`.
            include_extensions: ?[]const []const u8 = &.{".h"},

            pub fn dupe(opts: Directory.Options, graph: *const std.Build.Graph) Directory.Options {
                return .{
                    .exclude_extensions = graph.dupeStrings(opts.exclude_extensions),
                    .include_extensions = if (opts.include_extensions) |incs| graph.dupeStrings(incs) else null,
                };
            }
        }