Added util.ByteSizeNoLimit: a byte size of -1 means no limit, and any other negative size is rejected

ParseByteSize accepts "-1" or "-1B" as ByteSizeNoLimit, and String gives it
back as "-1". A setting for which no limit is unsafe can reject it.
This commit is contained in:
bwilliams committed 2026-10-15 15:57:30 +01:00
1 parent e19c8c2b69
commit 49b824d5a2
2 files changed
+44 -3

No files matched your search

+20 -2
View File
@@ -4,15 +4,21 @@ import (
"fmt"
"math"
"strconv"
"strings"
"github.com/dustin/go-humanize"
)
// ByteSize is a size in bytes, configured as a string such as "32KiB", "1MB"
// or "1.5 GB" (see ParseByteSize). KB, MB, ... are powers of 1000 and KiB,
// MiB, ... powers of 1024; a bare number is bytes.
// MiB, ... powers of 1024; a bare number is bytes. ByteSizeNoLimit (-1) means
// no limit; no other size is negative.
type ByteSize int64
// ByteSizeNoLimit is the size that means no limit, written "-1". A setting
// for which no limit is unsafe rejects it.
const ByteSizeNoLimit ByteSize = -1
// byteUnits are the units String may use, largest first.
var byteUnits = []struct {
name string
@@ -27,8 +33,16 @@ var byteUnits = []struct {
}
// ParseByteSize parses a size such as "32KiB", "1 MB" or "4096". Unit names
// are case-insensitive.
// are case-insensitive. "-1" (or "-1B") is ByteSizeNoLimit; any other
// negative size is an error.
func ParseByteSize(s string) (ByteSize, error) {
trimmed := strings.TrimSpace(s)
if trimmed == "-1" || strings.EqualFold(trimmed, "-1B") {
return ByteSizeNoLimit, nil
}
if strings.HasPrefix(trimmed, "-") {
return 0, fmt.Errorf("byte size %q is negative; only -1 (no limit) is allowed", s)
}
n, err := humanize.ParseBytes(s)
if err != nil {
return 0, err
@@ -41,7 +55,11 @@ func ParseByteSize(s string) (ByteSize, error) {
// String formats b exactly, in the largest unit that divides it (e.g. "32KiB",
// "1MB"), or in bytes ("1500B"), so it parses back to the same value.
// ByteSizeNoLimit is "-1".
func (b ByteSize) String() string {
if b == ByteSizeNoLimit {
return "-1"
}
if b != 0 {
for _, u := range byteUnits {
if int64(b)%u.size == 0 {
+24 -1
View File
@@ -1,6 +1,9 @@
package util
import "testing"
import (
"strings"
"testing"
)
func TestByteSizeString(t *testing.T) {
tests := []struct {
@@ -25,3 +28,23 @@ func TestByteSizeString(t *testing.T) {
}
}
}
// -1 is ByteSizeNoLimit, parsed and formatted as "-1"; no other size may be
// negative.
func TestByteSizeNoLimit(t *testing.T) {
for _, text := range []string{"-1", "-1B", "-1b", " -1 "} {
size, err := ParseByteSize(text)
if err != nil || size != ByteSizeNoLimit {
t.Errorf("ParseByteSize(%q) = %d, %v; want ByteSizeNoLimit", text, size, err)
}
}
if got := ByteSizeNoLimit.String(); got != "-1" {
t.Errorf("ByteSizeNoLimit.String() = %q; want -1", got)
}
for _, text := range []string{"-2", "-1KB", "-0.5", "-1KiB", "-100"} {
size, err := ParseByteSize(text)
if err == nil || !strings.Contains(err.Error(), "only -1 (no limit)") {
t.Errorf("ParseByteSize(%q) = %d, %v; want a negative size error", text, size, err)
}
}
}