struct Options [src]

Fields

draw_buffer: []u8 = &default_draw_bufferUser-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: u64 = 80 * std.time.ns_per_msHow many nanoseconds between writing updates to the terminal.

initial_delay_ns: u64 = 200 * std.time.ns_per_msHow many nanoseconds to keep the output hidden

estimated_total_items: usize = 0If provided, causes the progress item to have a denominator. 0 means unknown.

root_name: []const u8 = ""

disable_printing: bool = false

Source

  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: u64 = 80 * std.time.ns_per_ms,
    /// How many nanoseconds to keep the output hidden
    initial_delay_ns: u64 = 200 * std.time.ns_per_ms,
    /// 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,
}  