Documentation
¶
Index ¶
- Constants
- Variables
- func CopyDir(source, dest string) error
- func CopyFile(source, dest string) error
- func Critical(v ...interface{})
- func IsVersion(str string) bool
- func JoinErrors(errs []error, sep string) error
- func Severe(v ...interface{})
- func TempDir(dirs ...string) string
- func VersionCmp(a, b string) int
Constants ¶
const ( // Version is the current version of siad. Version = "1.0.3" // 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"
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 CopyDir ¶ added in v1.0.0
CopyDir copies a directory and all of its contents to the destination directory.
func Critical ¶ added in v1.0.0
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 JoinErrors ¶ added in v1.0.0
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 Severe ¶ added in v1.0.3
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 ¶ added in v0.3.2
TempDir joins the provided directories and prefixes them with the Sia testing directory.
func VersionCmp ¶ added in v1.0.0
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 ¶
This section is empty.
Source Files