File: bytes_formatting.h

package info (click to toggle)
chromium 145.0.7632.159-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,976,224 kB
  • sloc: cpp: 36,198,469; ansic: 7,634,080; javascript: 3,564,060; python: 1,649,622; xml: 838,470; asm: 717,087; pascal: 185,708; sh: 88,786; perl: 88,718; objc: 79,984; sql: 59,811; cs: 42,452; fortran: 24,101; makefile: 21,144; tcl: 15,277; php: 14,022; yacc: 9,066; ruby: 7,553; awk: 3,720; lisp: 3,233; lex: 1,328; ada: 727; jsp: 228; sed: 36
file content (70 lines) | stat: -rw-r--r-- 2,411 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
// Copyright 2011 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef UI_BASE_TEXT_BYTES_FORMATTING_H_
#define UI_BASE_TEXT_BYTES_FORMATTING_H_

#include <string>

#include "base/byte_size.h"
#include "base/component_export.h"

namespace ui {

// Simple API ------------------------------------------------------------------

// Simple call to return a byte quantity as a string in human-readable format.
//
// For example:
//   FormatBytes(base::ByteSize(512)) => "512 B"
//   FormatBytes(base::ByteSize(101479)) => "99.1 kB"
COMPONENT_EXPORT(UI_BASE) std::u16string FormatBytes(base::ByteSize bytes);

// Simple call to return a speed as a string in human-readable format.
//
// For example:
//   FormatSpeed(base::ByteSize(512)) => "512 B/s"
//   FormatSpeed(base::ByteSize(101479)) => "99.1 kB/s"
COMPONENT_EXPORT(UI_BASE) std::u16string FormatSpeed(base::ByteSize bytes);

// Less-Simple API -------------------------------------------------------------

enum class DataUnits {
  kByte = 0,
  kKibibyte,
  kMebibyte,
  kGibibyte,
  kTebibyte,
  kPebibyte
};

// Return the unit type that is appropriate for displaying the amount of bytes
// passed in. Most of the time, an explicit call to this isn't necessary; just
// use FormatBytes()/FormatSpeed() above.
COMPONENT_EXPORT(UI_BASE) DataUnits GetByteDisplayUnits(base::ByteSize bytes);

// Return a byte quantity as a string in human-readable format with an optional
// unit suffix. Specify in the `units` argument the units to be used.
//
// For example:
//   FormatBytes(base::ByteSize(512), DataUnits::kKibibyte, true) => "0.5 kB"
//   FormatBytes(base::KiB(10), DataUnits::kMebibyte, false) => "0.1"
COMPONENT_EXPORT(UI_BASE)
std::u16string FormatBytesWithUnits(base::ByteSize bytes,
                                    DataUnits units,
                                    bool show_units);

// As above, but with "/s" units for speed values.
//
// For example:
//   FormatSpeed(base::ByteSize(512), DataUnits::kKibibyte, true) => "0.5 kB/s"
//   FormatSpeed(base::KiB(10), DataUnits::kMebibyte, false) => "0.1"
COMPONENT_EXPORT(UI_BASE)
std::u16string FormatSpeedWithUnits(base::ByteSize bytes,
                                    DataUnits units,
                                    bool show_units);

}  // namespace ui

#endif  // UI_BASE_TEXT_BYTES_FORMATTING_H_