vfscommons

Documentation

Index

• Constants
• Variables
• func Absolutize(root, path string) string
• func EnsureRelativePath(path string) string
• func ErrorContains(err error, text string) bool
• func IsFile(path string) bool
• func NewVfsFile(absolutePath, root string, item interface{}) *gg_vfs.VfsFile
• func ReadKey(pathOrKey string) ([]byte, error)
• func Relativize(root string, path string) string
• func SplitHost(settings *vfsoptions.VfsOptions) (host string, port int)
• type IVfs
• type IVfsBuilder

Constants

const (
	SchemaFTP  = "ftp"
	SchemaSFTP = "sftp"
	SchemaOS   = "file"
)

const (
	PrefixUserHome  = "~"
	PrefixWorkspace = "*"
)

Variables

var (
	MissingConfigurationError  = errors.New("missing configuration")
	MismatchConfigurationError = errors.New("mismatch configuration")
	MissingConnectionError     = errors.New("missing connection")
	UnsupportedSchemaError     = errors.New("unsupported schema")
)

Functions

func Absolutize

func Absolutize(root, path string) string

func EnsureRelativePath

func EnsureRelativePath(path string) string

func ErrorContains

func ErrorContains(err error, text string) bool

func IsFile

func IsFile(path string) bool

func NewVfsFile

func NewVfsFile(absolutePath, root string, item interface{}) *gg_vfs.VfsFile

func ReadKey

func ReadKey(pathOrKey string) ([]byte, error)

func Relativize

func Relativize(root string, path string) string

func SplitHost

func SplitHost(settings *vfsoptions.VfsOptions) (host string, port int)

Types

type IVfs

type IVfs interface {
	IsConnected() bool
	Schema() string
	Path() string
	Options() (response map[string]interface{})
	Close()
	Cd(path string) (bool, error)
	Download(source, target string) ([]byte, error)
	gg_vfs.IVFSController
}

type IVfsBuilder

type IVfsBuilder func(opts any) (response IVfs, err error)