mutagen

Documentation

Overview

Package mutagen provides common version and legal metadata for Mutagen.

Index

• Constants
• Variables
• func ClientVersionHandshake(connection net.Conn) error
• func ServerVersionHandshake(connection net.Conn) 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 = 11
	// VersionPatch represents the current patch version of Mutagen.
	VersionPatch = 0
	// 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 = "alpha3"
)

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

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

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

Variables

var DebugEnabled bool

DebugEnabled controls whether or not debugging is enabled for Mutagen. It is set automatically based on the MUTAGEN_DEBUG environment variable.

var DevelopmentModeEnabled bool

DevelopmentModeEnabled controls whether or not development mode is enabled for Mutagen. It is set automatically based on the MUTAGEN_DEVELOPMENT environment variable.

var Version string

Version provides a stringified version of the current Mutagen version.

Functions

func ClientVersionHandshake

func ClientVersionHandshake(connection net.Conn) error

ClientVersionHandshake performs the client side of a version handshake, returning an error if the received server version is not compatible with the client version.

TODO: Add some ability to support version skew in this function.

func ServerVersionHandshake

func ServerVersionHandshake(connection net.Conn) error

ServerVersionHandshake performs the server side of a version handshake, returning an error if the received client version is not compatible with the server version.

TODO: Add some ability to support version skew in this function.

func SourceTreePath

func SourceTreePath() (string, error)

SourceTreePath computes the path to the Mutagen source directory.