libstone

package module

v0.0.0-...-092eee8 Latest Latest Go to latest Published: Feb 23, 2024 License: MPL-2.0 Imports: 3 Imported by: 0

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

This section is empty.

View Source

var (
	// ErrNoStone is returned when the magic number doesn't match
	// [MagicNumber].
	ErrNoStone = errors.New("data is not a stone archive")
)

This section is empty.

type Prelude struct {
	Data PreludeData

	// Version is the version of this stone archive.
	Version Version
}

Prelude is the header of the stone format.

func ReadPrelude(src io.Reader) (Prelude, error)

type PreludeData [24]byte

PreludeData is an agnostic array of bytes extending the base Prelude. Its meaning varies according to Version.

type Version uint32

Version is the stone format version contained inside the Prelude.

const (
	// V1 is the first version of the stone format.
	V1 Version = iota + 1
)