[go: up one dir, main page]

stringid

package
v2.0.0-beta.0 Latest Latest
Warning

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

Go to latest
Published: Sep 5, 2025 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package stringid provides helper functions for dealing with string identifiers

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenerateRandomID

func GenerateRandomID() string

GenerateRandomID returns a unique, 64-character ID consisting of a-z, 0-9. It guarantees that the ID, when truncated (TruncateID) does not consist of numbers only, so that the truncated ID can be used as hostname for containers.

func TruncateID

func TruncateID(id string) string

TruncateID returns a shorthand version of a string identifier for presentation. For convenience, it accepts both digests ("sha256:xxxx") and IDs without an algorithm prefix. It truncates the algorithm (if any) before truncating the ID. The length of the truncated ID is currently fixed, but users should make no assumptions of this to not change; it is merely a prefix of the ID that provides enough uniqueness for common scenarios.

Truncated IDs ("ID-prefixes") usually can be used to uniquely identify an object (such as a container or network), but collisions may happen, in which case an "ambiguous result" error is produced. In case of a collision, the caller should try with a longer prefix or the full-length ID.

Types

This section is empty.

Jump to

Keyboard shortcuts

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