libzed/progress_8hpp_source.html

#pragma once


#include "../core/string.hpp"

#include "../core/timeout.hpp"


namespace z {

namespace util {


class progress {

    core::timeout timer;

    bool displayed;


public:

    progress(unsigned int update_freq_micros = 100000) noexcept;


    void set(std::ostream &stream, long item, long max, const zstring &message = "", bool force = false) noexcept;


    void done(std::ostream &stream) noexcept;

};


} // namespace util

} // namespace z

z::core::string
A template class for character strings.
Definition string.hpp:62

z::core::timeout
A class for easily managing timing.
Definition timeout.hpp:13

z::util::progress
A class for outputting a progress bar to the terminal.
Definition progress.hpp:15

z::util::progress::done
void done(std::ostream &stream) noexcept
Mark the progress bar as finished.

z::util::progress::set
void set(std::ostream &stream, long item, long max, const zstring &message="", bool force=false) noexcept
Update the progress bar.

z::util::progress::progress
progress(unsigned int update_freq_micros=100000) noexcept
Constructor.