tlx
format_iec_units.hpp
Go to the documentation of this file.
1 /*******************************************************************************
2  * tlx/string/format_iec_units.hpp
3  *
4  * Part of tlx - http://panthema.net/tlx
5  *
6  * Copyright (C) 2016-2017 Timo Bingmann <tb@panthema.net>
7  *
8  * All rights reserved. Published under the Boost Software License, Version 1.0
9  ******************************************************************************/
10 
11 #ifndef TLX_STRING_FORMAT_IEC_UNITS_HEADER
12 #define TLX_STRING_FORMAT_IEC_UNITS_HEADER
13 
14 #include <string>
15 
16 namespace tlx {
17 
18 //! \addtogroup tlx_string
19 //! \{
20 
21 //! Format a byte size using IEC (Ki, Mi, Gi, Ti) suffixes (powers of
22 //! two). Returns "123 Ki" or similar.
23 std::string format_iec_units(uint64_t number, int precision = 3);
24 
25 //! \}
26 
27 } // namespace tlx
28 
29 #endif // !TLX_STRING_FORMAT_IEC_UNITS_HEADER
30 
31 /******************************************************************************/
std::string format_iec_units(uint64_t number, int precision=3)
Format a byte size using IEC (Ki, Mi, Gi, Ti) suffixes (powers of two).