common

Documentation

Overview

Code generated for package common by go-bindata DO NOT EDIT. (@generated) sources: assets/help.txt assets/help_standalone.txt

Index

• Constants
• Variables
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func ByteSliceEqual(a, b []byte) bool
• func CreateDirIfDoesNotExist(dir string) error
• func GetPassphrase(confirm bool) (string, error)
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error

Constants

const (
	// EncryptionDir the directory name that the standalone CLI will encrypt.
	EncryptionDir = "./secure"
)

Variables

var (
	// ProhibitedFiles represents the filenames
	// that will not be encrypted or decrypted.
	ProhibitedFiles = []string{
		"System Volume Information",
		".Trashes",
		".Spotlight-V100",
		".fseventsd",
	}

	// OSSlash represents the filepath slash delimiter for the current OS.
	OSSlash = "/"
)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func ByteSliceEqual

func ByteSliceEqual(a, b []byte) bool

ByteSliceEqual returns true if two []byte a and b are equal, false if they are not.

func CreateDirIfDoesNotExist

func CreateDirIfDoesNotExist(dir string) error

CreateDirIfDoesNotExist creates a directory if it does not already exist.

func GetPassphrase

func GetPassphrase(confirm bool) (string, error)

GetPassphrase will read a passphrase from stdin.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively