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.zon.parse.Options
pub const Options = struct

Configuration for the runtime parser.

Fields

ignore_unknown_fields: bool = false

If true, unknown fields do not error.

free_on_error: bool = true

If true, the parser cleans up partially parsed values on error. This requires some extra bookkeeping, so you may want to turn it off if you don't need this feature (e.g. because you're using arena allocation.)

File

zon/parse.zig:27
27
28
29
30
31
32
33
34
pub const Options = struct {
    /// If true, unknown fields do not error.
    ignore_unknown_fields: bool = false,
    /// If true, the parser cleans up partially parsed values on error. This requires some extra
    /// bookkeeping, so you may want to turn it off if you don't need this feature (e.g. because
    /// you're using arena allocation.)
    free_on_error: bool = true,
}