identifiers

package
v2.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 3, 2026 License: MIT Imports: 1 Imported by: 0

Documentation

Overview

Package identifiers provides the canonical set of named values accepted by CalcMark functions. This is the single source of truth for network scopes, network types, storage types, and compression types.

All consumers (spec/semantic, spec/features, impl/interpreter) derive their identifier lists from this package. This eliminates drift between layers.

Index

Constants

This section is empty.

Variables

View Source
var CompressionTypes = []string{"gzip", "zstd", "lz4", "snappy", "bzip2", "none"}

CompressionTypes lists valid compression type identifiers for compress().

View Source
var NetworkScopes = []string{"local", "regional", "continental", "global"}

NetworkScopes lists valid scope identifiers for rtt() and transfer_time(). Ordered by most commonly used first — first element is the representative example shown in the TUI compact footer.

View Source
var NetworkTypes = []string{"gigabit", "ten_gig", "hundred_gig", "wifi", "four_g", "five_g"}

NetworkTypes lists valid network type identifiers for throughput() and transfer_time().

View Source
var StorageAliases = map[string]string{"sata_ssd": "ssd"}

StorageAliases maps alternative storage names to their canonical name. The interpreter accepts both the canonical name and any alias.

View Source
var StorageTypes = []string{"ssd", "nvme", "pcie_ssd", "hdd"}

StorageTypes lists valid storage type identifiers for read() and seek().

View Source
var TimeUnits = []string{"nanosecond", "microsecond", "millisecond", "second", "minute", "hour", "day", "week", "month", "year"}

TimeUnits lists valid time unit identifiers accepted by convert_rate() and other rate/duration-manipulating functions. Ordered from smallest to largest so "second" is the representative example.

Functions

func AllStorageNames

func AllStorageNames() []string

AllStorageNames returns all valid storage names including aliases. Used by interpreter validation and error messages.

func JoinNames

func JoinNames(names []string) string

JoinNames formats a name list for error messages: "ssd, nvme, pcie_ssd, hdd".

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL