libstone

Documentation

Index

• Variables
• type Prelude
  • func ReadPrelude(src io.Reader) (Prelude, error)
• type PreludeData
• type Version

Variables

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

Types

type Prelude

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

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

type PreludeData

type PreludeData [24]byte

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

type 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
)