storepath

package

v0.0.0-...-93cb24a Latest Latest Go to latest Published: Dec 19, 2023 License: Apache-2.0 Imports: 4 Imported by: 5

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/nix-community/go-nix

Links

Open Source Insights

Documentation ¶

Overview ¶

Package storepath parses and renders Nix store paths.

Index ¶

Constants
Variables
func Validate(s string) error
type StorePath
- func FromAbsolutePath(s string) (*StorePath, error)
- func FromString(s string) (*StorePath, error)

Constants ¶

View Source

const (
	StoreDir     = "/nix/store"
	PathHashSize = 20
)

Variables ¶

View Source

var (
	NameRe = regexp.MustCompile(`[a-zA-Z0-9+\-_?=][.a-zA-Z0-9+\-_?=]*`)
	PathRe = regexp.MustCompile(fmt.Sprintf(
		`^%v/([%v]{%d})-(%v)$`,
		regexp.QuoteMeta(StoreDir),
		nixbase32.Alphabet,
		nixbase32.EncodedLen(PathHashSize),
		NameRe,
	))
)

Functions ¶

func Validate ¶

func Validate(s string) error

Validate validates an absolute Nix Store Path string.

Types ¶

type StorePath ¶

type StorePath struct {
	Name   string
	Digest []byte
}

StorePath represents a bare Nix store path, without any paths underneath `/nix/store/…-…`.

func FromAbsolutePath ¶

func FromAbsolutePath(s string) (*StorePath, error)

FromAbsolutePath parses an absolute Nix Store path including store prefix) into a StorePath, verifying it's syntactically valid. It returns an error if it fails to parse.

func FromString ¶

func FromString(s string) (*StorePath, error)

FromString parses a Nix store path without store prefix into a StorePath, verifying it's syntactically valid. It returns an error if it fails to parse.

func (*StorePath) Absolute ¶

func (n *StorePath) Absolute() string

Absolute returns a StorePath with StoreDir and slash prepended. We use forward slashes on all architectures (including Windows), to be consistent in hashing contexts.

func (*StorePath) String ¶

func (n *StorePath) String() string

String returns a Store without StoreDir. It starts with a digest (20 bytes), nixbase32-encoded, followed by a `-`, and ends with the name.

func (*StorePath) Validate ¶

func (n *StorePath) Validate() error

Validate validates a StorePath, verifying it's syntactically valid.

Source Files ¶

View all Source files

storepath.go

Directories ¶

Path	Synopsis
references

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