54 lines
1.5 KiB
C++
54 lines
1.5 KiB
C++
/*
|
|
* This file is part of Scylla.
|
|
*
|
|
* Scylla is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Scylla is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Scylla. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/*
|
|
* Copyright (C) 2020-present ScyllaDB
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <cinttypes>
|
|
#include <iosfwd>
|
|
|
|
namespace utils {
|
|
|
|
struct human_readable_value {
|
|
uint16_t value; // [0, 1024)
|
|
char suffix; // 0 -> no suffix
|
|
};
|
|
|
|
std::ostream& operator<<(std::ostream& os, const human_readable_value& val);
|
|
|
|
/// Convert a size to a human readable representation.
|
|
///
|
|
/// The human-readable representation has at most 4 digits
|
|
/// and a letter appropriate to the power of two the number has to be multiplied
|
|
/// with to arrive to the original number (with some loss of precision).
|
|
/// The different powers of two are the conventional 2 ** (N * 10) variants:
|
|
/// * N=0: (B)ytes
|
|
/// * N=1: (K)bytes
|
|
/// * N=2: (M)bytes
|
|
/// * N=3: (G)bytes
|
|
/// * N=4: (T)bytes
|
|
///
|
|
/// Examples:
|
|
/// * 87665 will be converted to 87K
|
|
/// * 1024 will be converted to 1K
|
|
human_readable_value to_hr_size(uint64_t size);
|
|
|
|
} // namespace utils
|