mutagen

Documentation

Overview

Package mutagen provides common version and legal metadata for Mutagen.

Index

• Constants
• Variables
• func ReceiveAndCompareVersion(reader io.Reader) (bool, error)
• func ReceiveVersion(reader io.Reader) (uint32, uint32, uint32, error)
• func SendVersion(writer io.Writer) error
• func SourceTreePath() (string, error)

Constants

const (
	// VersionMajor represents the current major version of Mutagen.
	VersionMajor = 0
	// VersionMinor represents the current minor version of Mutagen.
	VersionMinor = 9
	// VersionPatch represents the current patch version of Mutagen.
	VersionPatch = 2
	// VersionTag represents a tag to be appended to the Mutagen version string.
	// It must not contain spaces. If empty, no tag is appended to the version
	// string.
	VersionTag = ""
)

const (
	// BuildDirectoryName is the name of the build directory to create inside
	// the root of the Mutagen source tree.
	BuildDirectoryName = "build"
)

const LegalNotice = `` /* 26588-byte string literal not displayed */

LegalNotice provides license notices for Mutagen itself and any third-party dependencies.

Variables

var Version string

Version provides a stringified version of the current Mutagen version.

Functions

func ReceiveAndCompareVersion

func ReceiveAndCompareVersion(reader io.Reader) (bool, error)

ReceiveAndCompareVersion reads version information from the specified reader and ensures that it matches the current Mutagen version. Version tag components are neither transmitted nor received, so they do not enter into this comparison.

func ReceiveVersion

func ReceiveVersion(reader io.Reader) (uint32, uint32, uint32, error)

ReceiveVersion reads version information from the specified reader. Version tag components are neither transmitted nor received.

func SendVersion

func SendVersion(writer io.Writer) error

SendVersion writes the current Mutagen version to the specified writer. Version tag components are neither transmitted nor received.

func SourceTreePath

func SourceTreePath() (string, error)

SourceTreePath computes the path to the Mutagen source directory.