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

Fields

draw_buffer: []u8 = &default_draw_buffer

User-provided buffer with static lifetime.

Used to store the entire write buffer sent to the terminal. Progress output will be truncated if it cannot fit into this buffer which will look bad but not cause any malfunctions.

Must be at least 200 bytes.

refresh_rate_ns: Io.Duration = .fromMilliseconds(80)

How many nanoseconds between writing updates to the terminal.

initial_delay_ns: Io.Duration = .fromMilliseconds(200)

How many nanoseconds to keep the output hidden

estimated_total_items: usize = 0

If provided, causes the progress item to have a denominator. 0 means unknown.

root_name: []const u8 = ""
disable_printing: bool = false

File

Progress.zig:574
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
pub const Options = struct {
    /// User-provided buffer with static lifetime.
    ///
    /// Used to store the entire write buffer sent to the terminal. Progress output will be truncated if it
    /// cannot fit into this buffer which will look bad but not cause any malfunctions.
    ///
    /// Must be at least 200 bytes.
    draw_buffer: []u8 = &default_draw_buffer,
    /// How many nanoseconds between writing updates to the terminal.
    refresh_rate_ns: Io.Duration = .fromMilliseconds(80),
    /// How many nanoseconds to keep the output hidden
    initial_delay_ns: Io.Duration = .fromMilliseconds(200),
    /// If provided, causes the progress item to have a denominator.
    /// 0 means unknown.
    estimated_total_items: usize = 0,
    root_name: []const u8 = "",
    disable_printing: bool = false,
}