bwilliams
67215a6aaa
CODE_CONVENTIONS.md sets out the conventions for Go code in this repository: naming, layout, comments, errors, logging, configuration and tests. .golangci.json enables the linters that check the parts that can be checked (each limited to the rules the conventions use); the rest is applied by hand. Applied across the codebase: - Naming: full-word names in application code, initialisms in one case (BuyerID, PrintJSON, PrintYAML, ocdsGetBuyerID), no names shadowing built-ins (min/max are minGap/maxGap), mustRaw renamed rawJSON as it returns nil rather than panicking, and config.ConfigLevelToLogLevel renamed LevelToLogLevel. - Layout: lines kept to 80 characters where possible, assignments taken out of if and for statements that don't fit, wrapped arguments all on one line or one per line, steps separated by blank lines, no else after a return, function and struct literals wrapped. - Comments: doc comments on every exported name (including each section's Map, Flatten, TypeOf, ValueOf and SetValue), section banners, British spelling. - Errors: a created error starts with its package name, a wrapping error adds only what was being done, sentinels in one commented var block, errors.Is and errors.As in place of == and type assertions, and no err := shadowing of a named result. That fixes the mock server losing its access log's close error. - Logging: the fetcher passes its workers an untagged logger, so findatender's lines are tagged with their own component rather than with fetcher's as well; cmd/mock-fts logs "stopped" with slog. - Configuration: util.WithTimeout (moved from the websocket package) applies a timeout of 0 or less as no limit, used for the websocket write and ping, TCP close and tcpserver shutdown timeouts; every setting documents what 0 or empty means, including the rate limit rule's keys in internal/config/README.md. - Tests: related tests merged into table-driven ones with named cases. Separately from CODE_CONVENTIONS.md, internal/store/README.md gains a soft SQL style convention for the queries in internal/store/queries.go, and the queries are reformatted to follow it.
118 lines
2.3 KiB
Go
118 lines
2.3 KiB
Go
package util
|
|
|
|
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. 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
|
|
size int64
|
|
}{
|
|
{
|
|
name: "EiB",
|
|
size: humanize.EiByte,
|
|
},
|
|
{
|
|
name: "EB",
|
|
size: humanize.EByte,
|
|
},
|
|
{
|
|
name: "PiB",
|
|
size: humanize.PiByte,
|
|
},
|
|
{
|
|
name: "PB",
|
|
size: humanize.PByte,
|
|
},
|
|
{
|
|
name: "TiB",
|
|
size: humanize.TiByte,
|
|
},
|
|
{
|
|
name: "TB",
|
|
size: humanize.TByte,
|
|
},
|
|
{
|
|
name: "GiB",
|
|
size: humanize.GiByte,
|
|
},
|
|
{
|
|
name: "GB",
|
|
size: humanize.GByte,
|
|
},
|
|
{
|
|
name: "MiB",
|
|
size: humanize.MiByte,
|
|
},
|
|
{
|
|
name: "MB",
|
|
size: humanize.MByte,
|
|
},
|
|
{
|
|
name: "KiB",
|
|
size: humanize.KiByte,
|
|
},
|
|
{
|
|
name: "KB",
|
|
size: humanize.KByte,
|
|
},
|
|
}
|
|
|
|
// ParseByteSize parses a size such as "32KiB", "1 MB" or "4096". Unit names
|
|
// are case-insensitive. "-1" (or "-1B") is ByteSizeNoLimit; any other
|
|
// negative size is an error.
|
|
func ParseByteSize(text string) (ByteSize, error) {
|
|
trimmed := strings.TrimSpace(text)
|
|
if trimmed == "-1" || strings.EqualFold(trimmed, "-1B") {
|
|
return ByteSizeNoLimit, nil
|
|
}
|
|
if strings.HasPrefix(trimmed, "-") {
|
|
return 0, fmt.Errorf(
|
|
"util: byte size %q is negative; only -1 (no limit) is allowed", text,
|
|
)
|
|
}
|
|
|
|
parsed, err := humanize.ParseBytes(text)
|
|
if err != nil {
|
|
return 0, err
|
|
}
|
|
if parsed > math.MaxInt64 {
|
|
return 0, fmt.Errorf("util: byte size %q is too large", text)
|
|
}
|
|
|
|
return ByteSize(parsed), nil
|
|
}
|
|
|
|
// 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 _, unit := range byteUnits {
|
|
if int64(b)%unit.size == 0 {
|
|
return strconv.FormatInt(int64(b)/unit.size, 10) + unit.name
|
|
}
|
|
}
|
|
}
|
|
return strconv.FormatInt(int64(b), 10) + "B"
|
|
}
|