-
Notifications
You must be signed in to change notification settings - Fork 338
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor and cleanup byte utilities (#7406)
- Loading branch information
1 parent
fa1760f
commit d1df40c
Showing
27 changed files
with
267 additions
and
197 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
117 changes: 117 additions & 0 deletions
117
packages/devtools_app/lib/src/shared/primitives/byte_utils.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| // Copyright 2024 The Chromium Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style license that can be | ||
| // found in the LICENSE file. | ||
|
|
||
| import 'dart:math'; | ||
|
|
||
| String? prettyPrintBytes( | ||
| num? bytes, { | ||
| int kbFractionDigits = 1, | ||
| int mbFractionDigits = 1, | ||
| int gbFractionDigits = 1, | ||
| bool includeUnit = false, | ||
| num roundingPoint = 1.0, | ||
| int maxBytes = 52, | ||
| }) { | ||
| if (bytes == null) { | ||
| return null; | ||
| } | ||
| // TODO(kenz): Generalize to handle different kbFractionDigits. | ||
| // Ensure a small number of bytes does not print as 0 KB. | ||
| // If bytes >= maxBytes and kbFractionDigits == 1, it will start rounding to | ||
| // 0.1 KB. | ||
| if (bytes.abs() < maxBytes && kbFractionDigits == 1) { | ||
| var output = bytes.toString(); | ||
| if (includeUnit) { | ||
| output += ' B'; | ||
| } | ||
| return output; | ||
| } | ||
| final sizeInMB = convertBytes(bytes.abs(), to: ByteUnit.mb); | ||
| final sizeInGB = convertBytes(bytes.abs(), to: ByteUnit.gb); | ||
|
|
||
| ByteUnit printUnit; | ||
| if (sizeInGB >= roundingPoint) { | ||
| printUnit = ByteUnit.gb; | ||
| } else if (sizeInMB >= roundingPoint) { | ||
| printUnit = ByteUnit.mb; | ||
| } else { | ||
| printUnit = ByteUnit.kb; | ||
| } | ||
|
|
||
| final fractionDigits = switch (printUnit) { | ||
| ByteUnit.kb => kbFractionDigits, | ||
| ByteUnit.mb => mbFractionDigits, | ||
| ByteUnit.gb || _ => gbFractionDigits, | ||
| }; | ||
|
|
||
| return printBytes( | ||
| bytes, | ||
| unit: printUnit, | ||
| fractionDigits: fractionDigits, | ||
| includeUnit: includeUnit, | ||
| ); | ||
| } | ||
|
|
||
| String printBytes( | ||
| num bytes, { | ||
| ByteUnit unit = ByteUnit.byte, | ||
| int fractionDigits = 1, | ||
| bool includeUnit = false, | ||
| }) { | ||
| if (unit == ByteUnit.kb) { | ||
| // We add ((1024/2)-1) to the value before formatting so that a non-zero | ||
| // byte value doesn't round down to 0. If showing decimal points, let it | ||
| // round normally. | ||
| // TODO(peterdjlee): Round up to the respective digit when fractionDigits > 0. | ||
| bytes = fractionDigits == 0 ? bytes + 511 : bytes; | ||
| } | ||
| final bytesDisplay = | ||
| convertBytes(bytes, to: unit).toStringAsFixed(fractionDigits); | ||
| final unitSuffix = includeUnit ? ' ${unit.display}' : ''; | ||
| return '$bytesDisplay$unitSuffix'; | ||
| } | ||
|
|
||
| num convertBytes( | ||
| num value, { | ||
| ByteUnit from = ByteUnit.byte, | ||
| required ByteUnit to, | ||
| }) { | ||
| final multiplier = to.multiplierCount - from.multiplierCount; | ||
| final multiplierValue = pow(ByteUnit.unitMultiplier, multiplier.abs()); | ||
|
|
||
| if (multiplier > 0) { | ||
| // A positive multiplier indicates that we are going from a smaller unit to | ||
| // a larger unit (e.g. from bytes to GB). | ||
| return value / multiplierValue; | ||
| } else if (multiplier < 0) { | ||
| // A positive multiplier indicates that we are going from a larger unit to | ||
| // a smaller unit (e.g. from GB to bytes). | ||
| return value * multiplierValue; | ||
| } else { | ||
| return value; | ||
| } | ||
| } | ||
|
|
||
| enum ByteUnit { | ||
| byte(multiplierCount: 0, display: 'bytes'), | ||
| kb(multiplierCount: 1), | ||
| mb(multiplierCount: 2), | ||
| gb(multiplierCount: 3); | ||
|
|
||
| const ByteUnit({required this.multiplierCount, String? display}) | ||
| : _display = display; | ||
|
|
||
| static const unitMultiplier = 1024.0; | ||
|
|
||
| /// The number of times this unit should be multiplied or divided by | ||
| /// [unitMultiplier] to convert between units. | ||
| /// | ||
| /// [ByteUnit.byte] is the baseline, with zero multipliers. All other units | ||
| /// have a value for [multiplierCount] that is relative to [ByteUnit.byte]. | ||
| final int multiplierCount; | ||
|
|
||
| final String? _display; | ||
|
|
||
| String get display => _display ?? name.toUpperCase(); | ||
| } |
Oops, something went wrong.