util

package

v0.5.2 Latest Latest Go to latest Published: Dec 8, 2018 License: Apache-2.0 Imports: 27 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/rancherio/volmgr

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func AttachLoopbackDevice(file string, readonly bool) (string, error)
func CheckBinaryVersion(binaryName, minVersion string, args []string) error
func CheckName(name string) error
func CompressData(data []byte) (io.ReadSeeker, error)
func CompressDir(sourceDir, targetFile string) error
func CompressFile(filePath string) error
func ConfigExists(fileName string) bool
func Copy(src, dst string) error
func DecompressAndVerify(src io.Reader, checksum string) (io.Reader, error)
func DecompressDir(sourceFile, targetDir string) error
func DecompressFile(filePath string) error
func DetachAnyLoopbackDevice(file string) error
func DetachLoopbackDevice(file, dev string) error
func EncodeData(v interface{}) (*bytes.Buffer, error)
func Execute(binary string, args []string) (string, error)
func ExtractNames(names []string, prefix, suffix string) ([]string, error)
func Freeze(mountpoint string) error
func GenerateName(prefix string) string
func GetChecksum(data []byte) string
func GetFieldFromOpts(name string, opts map[string]string) (string, error)
func GetFileChecksum(filePath string) (string, error)
func GetFlag(v interface{}, key string, required bool, err error) (string, error)
func GetName(v interface{}, key string, required bool, err error) (string, error)
func InitMountNamespace(fd string) error
func InitTimeout(timeout string)
func IsNotExistsError(err error) bool
func ListConfigIDs(root, prefix, suffix string) ([]string, error)
func ListLoopbackDevice(file string) ([]string, error)
func LoadConfig(fileName string, v interface{}) error
func LockFile(fileName string) (*os.File, error)
func MkdirIfNotExists(path string) error
func MountPointPrepareBlockDevice(mp string, dev string) error
func MountPointPrepareImageFile(mp string, size int64) error
func MountPointRemoveFile(file string) error
func NewUUID() string
func Now() string
func ObjectConfig(obj interface{}) (string, error)
func ObjectDelete(obj interface{}) error
func ObjectExists(obj interface{}) (bool, error)
func ObjectLoad(obj interface{}) error
func ObjectSave(obj interface{}) error
func ParseSize(size string) (int64, error)
func RemoveConfig(fileName string) error
func RequiredMissingError(name string) error
func SaveConfig(fileName string, v interface{}) error
func SliceToMap(slices []string) map[string]string
func Sync() error
func UnFreeze(mountpoint string) error
func UnescapeURL(url string) string
func UnlockFile(f *os.File) error
func ValidNetworkAddr(addr string) bool
func ValidateName(name string) bool
func VolumeMount(v interface{}, mountPoint string, remount bool) (string, error)
func VolumeMountPointDirectoryCreate(v interface{}, dirName string) error
func VolumeMountPointDirectoryRemove(v interface{}, dirName string) error
func VolumeMountPointFileExists(v interface{}, file string, expectType string) bool
func VolumeUmount(v interface{}) error
type Index
- func NewIndex() *Index
- func (idx *Index) Add(key, value string) error
- func (idx *Index) Delete(key string) error
- func (idx *Index) Get(key string) string
type ObjectOperations
type VolumeHelper

Constants ¶

View Source

const (
	MOUNT_BINARY   = "mount"
	UMOUNT_BINARY  = "umount"
	NSENTER_BINARY = "nsenter"

	IMAGE_FILE_NAME = "disk.img"
	BLOCK_DEV_NAME  = "disk.dev"

	FILE_TYPE_REGULAR     = "regular file"
	FILE_TYPE_DIRECTORY   = "directory"
	FILE_TYPE_BLOCKDEVICE = "block special file"

	FILE_STAT_FORMAT_SIZE        = "%s"
	FILE_STAT_FORMAT_TYPE        = "%F"
	FILE_STAT_FORMAT_MAJOR_MINOR = "%t %T"
)

View Source

const (
	PRESERVED_CHECKSUM_LENGTH = 64
)

Variables ¶

This section is empty.

Functions ¶

func AttachLoopbackDevice ¶

func AttachLoopbackDevice(file string, readonly bool) (string, error)

func CheckBinaryVersion ¶

func CheckBinaryVersion(binaryName, minVersion string, args []string) error

func CheckName ¶

func CheckName(name string) error

func CompressData ¶

func CompressData(data []byte) (io.ReadSeeker, error)

func CompressDir ¶

func CompressDir(sourceDir, targetFile string) error

func CompressFile ¶

func CompressFile(filePath string) error

func ConfigExists ¶

func ConfigExists(fileName string) bool

func Copy ¶

func Copy(src, dst string) error

func DecompressAndVerify ¶

func DecompressAndVerify(src io.Reader, checksum string) (io.Reader, error)

func DecompressDir ¶

func DecompressDir(sourceFile, targetDir string) error

If sourceFile is inside targetDir, it would be deleted automatically

func DecompressFile ¶

func DecompressFile(filePath string) error

func DetachAnyLoopbackDevice ¶ added in v0.5.0

func DetachAnyLoopbackDevice(file string) error

func DetachLoopbackDevice ¶

func DetachLoopbackDevice(file, dev string) error

func EncodeData ¶

func EncodeData(v interface{}) (*bytes.Buffer, error)

func Execute ¶

func Execute(binary string, args []string) (string, error)

func ExtractNames ¶ added in v0.5.0

func ExtractNames(names []string, prefix, suffix string) ([]string, error)

func Freeze ¶ added in v0.5.1

func Freeze(mountpoint string) error

func GenerateName ¶ added in v0.5.0

func GenerateName(prefix string) string

func GetChecksum ¶

func GetChecksum(data []byte) string

func GetFieldFromOpts ¶ added in v0.5.0

func GetFieldFromOpts(name string, opts map[string]string) (string, error)

func GetFileChecksum ¶

func GetFileChecksum(filePath string) (string, error)

func GetFlag ¶ added in v0.4.1

func GetFlag(v interface{}, key string, required bool, err error) (string, error)

func GetName ¶

func GetName(v interface{}, key string, required bool, err error) (string, error)

func InitMountNamespace ¶ added in v0.4.1

func InitMountNamespace(fd string) error

func InitTimeout ¶ added in v0.5.0

func InitTimeout(timeout string)

func IsNotExistsError ¶ added in v0.5.0

func IsNotExistsError(err error) bool

func ListConfigIDs ¶

func ListConfigIDs(root, prefix, suffix string) ([]string, error)

func ListLoopbackDevice ¶ added in v0.5.0

func ListLoopbackDevice(file string) ([]string, error)

func LoadConfig ¶

func LoadConfig(fileName string, v interface{}) error

func LockFile ¶

func LockFile(fileName string) (*os.File, error)

func MkdirIfNotExists ¶

func MkdirIfNotExists(path string) error

func MountPointPrepareBlockDevice ¶ added in v0.4.1

func MountPointPrepareBlockDevice(mp string, dev string) error

func MountPointPrepareImageFile ¶ added in v0.4.1

func MountPointPrepareImageFile(mp string, size int64) error

func MountPointRemoveFile ¶ added in v0.4.1

func MountPointRemoveFile(file string) error

func NewUUID ¶ added in v0.5.0

func NewUUID() string

func Now ¶

func Now() string

func ObjectConfig ¶

func ObjectConfig(obj interface{}) (string, error)

func ObjectDelete ¶

func ObjectDelete(obj interface{}) error

func ObjectExists ¶

func ObjectExists(obj interface{}) (bool, error)

func ObjectLoad ¶

func ObjectLoad(obj interface{}) error

func ObjectSave ¶

func ObjectSave(obj interface{}) error

func ParseSize ¶

func ParseSize(size string) (int64, error)

func RemoveConfig ¶

func RemoveConfig(fileName string) error

func RequiredMissingError ¶

func RequiredMissingError(name string) error

func SaveConfig ¶

func SaveConfig(fileName string, v interface{}) error

func SliceToMap ¶

func SliceToMap(slices []string) map[string]string

func Sync ¶ added in v0.5.1

func Sync() error

func UnFreeze ¶ added in v0.5.1

func UnFreeze(mountpoint string) error

func UnescapeURL ¶ added in v0.4.1

func UnescapeURL(url string) string

func UnlockFile ¶

func UnlockFile(f *os.File) error

func ValidNetworkAddr ¶ added in v0.4.1

func ValidNetworkAddr(addr string) bool

func ValidateName ¶

func ValidateName(name string) bool

func VolumeMount ¶ added in v0.4.1

func VolumeMount(v interface{}, mountPoint string, remount bool) (string, error)

func VolumeMountPointDirectoryCreate ¶ added in v0.4.1

func VolumeMountPointDirectoryCreate(v interface{}, dirName string) error

func VolumeMountPointDirectoryRemove ¶ added in v0.4.1

func VolumeMountPointDirectoryRemove(v interface{}, dirName string) error

func VolumeMountPointFileExists ¶ added in v0.4.1

func VolumeMountPointFileExists(v interface{}, file string, expectType string) bool

func VolumeUmount ¶ added in v0.4.1

func VolumeUmount(v interface{}) error

Types ¶

type Index ¶

type Index struct {
	// contains filtered or unexported fields
}

func NewIndex ¶

func NewIndex() *Index

func (*Index) Add ¶

func (idx *Index) Add(key, value string) error

func (*Index) Delete ¶

func (idx *Index) Delete(key string) error

func (*Index) Get ¶

func (idx *Index) Get(key string) string

type ObjectOperations ¶

type ObjectOperations interface {
	ConfigFile() (string, error)
}

type VolumeHelper ¶ added in v0.4.1

type VolumeHelper interface {
	GetDevice() (string, error)
	GetMountOpts() []string
	GenerateDefaultMountPoint() string
}

Caller must implement VolumeHelper interface, and must have fields "Name" and "MountPoint"

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL