build

Documentation

Index

• Constants
• Variables
• func ComposeErrors(errs ...error) error
• func CopyDir(source, dest string) error
• func CopyFile(source, dest string) error
• func Critical(v ...interface{})
• func ExtendErr(s string, err error) error
• func ExtractTarGz(filename, dir string) error
• func IsVersion(str string) bool
• func JoinErrors(errs []error, sep string) error
• func Retry(tries int, durationBetweenAttempts time.Duration, fn func() error) (err error)
• func Select(v Var) interface{}
• func Severe(v ...interface{})
• func TempDir(dirs ...string) string
• func VersionCmp(a, b string) int
• type Var

Constants

const (
	// Version is the current version of siad.
	Version = "1.3.0"

	// MaxEncodedVersionLength is the maximum length of a version string encoded
	// with the encode package. 100 is much larger than any version number we send
	// now, but it allows us to send additional information in the version string
	// later if we choose. For example appending the version string with the HEAD
	// commit hash.
	MaxEncodedVersionLength = 100
)

const DEBUG = false

const Release = "standard"

const VLONG = false

Variables

var (
	// SiaTestingDir is the directory that contains all of the files and
	// folders created during testing.
	SiaTestingDir = filepath.Join(os.TempDir(), "SiaTesting")
)

Functions

func ComposeErrors

func ComposeErrors(errs ...error) error

ComposeErrors will take multiple errors and compose them into a single errors with a longer message. Any nil errors used as inputs will be stripped out, and if there are zero non-nil inputs then 'nil' will be returned.

The original types of the errors is not preserved at all.

func CopyDir

func CopyDir(source, dest string) error

CopyDir copies a directory and all of its contents to the destination directory.

func CopyFile

func CopyFile(source, dest string) error

CopyFile copies a file from a source to a destination.

func Critical

func Critical(v ...interface{})

Critical should be called if a sanity check has failed, indicating developer error. Critical is called with an extended message guiding the user to the issue tracker on Github. If the program does not panic, the call stack for the running goroutine is printed to help determine the error.

func ExtendErr

func ExtendErr(s string, err error) error

ExtendErr will return a new error which extends the input error with a string. If the input error is nil, then 'nil' will be returned, discarding the input string.

func ExtractTarGz

func ExtractTarGz(filename, dir string) error

ExtractTarGz extracts the specified .tar.gz file to dir, overwriting existing files in the event of a name conflict.

func IsVersion

func IsVersion(str string) bool

IsVersion returns whether str is a valid version number.

func JoinErrors

func JoinErrors(errs []error, sep string) error

JoinErrors concatenates the elements of errs to create a single error. The separator string sep is placed between elements in the resulting error. Nil errors are skipped. If errs is empty or only contains nil elements, JoinErrors returns nil.

func Retry

func Retry(tries int, durationBetweenAttempts time.Duration, fn func() error) (err error)

Retry will call 'fn' 'tries' times, waiting 'durationBetweenAttempts' between each attempt, returning 'nil' the first time that 'fn' returns nil. If 'nil' is never returned, then the final error returned by 'fn' is returned.

func Select

func Select(v Var) interface{}

Select returns the field of v that corresponds to the current Release.

Since the caller typically makes a type assertion on the result, it is important to point out that type assertions are stricter than conversions. Specifically, you cannot write:

type myint int
Select(Var{0, 0, 0}).(myint)

Because 0 will be interpreted as an int, which is not assignable to myint. Instead, you must explicitly cast each field in the Var, or cast the return value of Select after the type assertion. The former is preferred.

func Severe

func Severe(v ...interface{})

Severe will print a message to os.Stderr. If DEBUG has been set panic will be called as well. Severe should be called in situations which indicate significant problems for the user (such as disk failure or random number generation failure), but where crashing is not strictly required to preserve integrity.

func TempDir

func TempDir(dirs ...string) string

TempDir joins the provided directories and prefixes them with the Sia testing directory.

func VersionCmp

func VersionCmp(a, b string) int

VersionCmp returns an int indicating the difference between a and b. It follows the convention of bytes.Compare and big.Cmp:

-1 if a <  b
 0 if a == b
+1 if a >  b

One important quirk is that "1.1.0" is considered newer than "1.1", despite being numerically equal.

Types

type Var

type Var struct {
	Standard interface{}
	Dev      interface{}
	Testing  interface{}
	// contains filtered or unexported fields
}

A Var represents a variable whose value depends on which Release is being compiled. None of the fields may be nil, and all fields must have the same type.