filesystem

Documentation

Index

• func FileExists(filename string) bool
• func FolderExists(filename string) bool
• func IsNotFoundError(err error) bool
• type FileGetOptions
• type FilePutOptions
• type FileStatOptions
• type FileSystem
• type FolderCreateOptions
• type LocalFs
  • func NewLocalFs(name, basepath string, logger *logging.Logger) (*LocalFs, error)
  • func (fs *LocalFs) BucketCreate(folder string, opts FolderCreateOptions) error
  • func (fs *LocalFs) BucketExists(folder string) (bool, error)
  • func (fs *LocalFs) FileExists(folder, name string) (bool, error)
  • func (fs *LocalFs) FileGet(folder, name string, opts FileGetOptions) ([]byte, error)
  • func (fs *LocalFs) FileOpenRead(folder, name string, opts FileGetOptions) (ReadSeekerCloser, os.FileInfo, error)
  • func (fs *LocalFs) FilePut(folder, name string, data []byte, opts FilePutOptions) error
  • func (fs *LocalFs) FileRead(folder, name string, w io.Writer, size int64, opts FileGetOptions) error
  • func (fs *LocalFs) FileStat(folder, name string, opts FileStatOptions) (os.FileInfo, error)
  • func (fs *LocalFs) FileWrite(folder, name string, r io.Reader, size int64, opts FilePutOptions) error
  • func (fs *LocalFs) GETUrl(folder, name string, valid time.Duration) (*url.URL, error)
  • func (fs *LocalFs) IsLocal() bool
  • func (fs *LocalFs) Protocol() string
  • func (fs *LocalFs) String() string
• type NotFoundError
  • func (nf *NotFoundError) Error() string
• type ReadSeekerCloser
• type S3FileInfo
  • func NewS3FileInfo(bucket, name string, info minio.ObjectInfo) *S3FileInfo
  • func (sfi *S3FileInfo) IsDir() bool
  • func (sfi *S3FileInfo) ModTime() time.Time
  • func (sfi *S3FileInfo) Mode() os.FileMode
  • func (sfi *S3FileInfo) Name() string
  • func (sfi *S3FileInfo) Size() int64
  • func (sfi *S3FileInfo) Sys() interface{}
• type S3Fs
  • func NewS3Fs(name, endpoint string, accessKeyId string, secretAccessKey string, useSSL bool) (*S3Fs, error)
  • func (fs *S3Fs) BucketCreate(folder string, opts FolderCreateOptions) error
  • func (fs *S3Fs) BucketExists(folder string) (bool, error)
  • func (fs *S3Fs) FileExists(folder, name string) (bool, error)
  • func (fs *S3Fs) FileGet(folder, name string, opts FileGetOptions) ([]byte, error)
  • func (fs *S3Fs) FileOpenRead(folder, name string, opts FileGetOptions) (ReadSeekerCloser, os.FileInfo, error)
  • func (fs *S3Fs) FilePut(folder, name string, data []byte, opts FilePutOptions) error
  • func (fs *S3Fs) FileRead(folder, name string, w io.Writer, size int64, opts FileGetOptions) error
  • func (fs *S3Fs) FileStat(folder, name string, opts FileStatOptions) (os.FileInfo, error)
  • func (fs *S3Fs) FileWrite(folder, name string, r io.Reader, size int64, opts FilePutOptions) error
  • func (fs *S3Fs) GETUrl(folder, name string, valid time.Duration) (*url.URL, error)
  • func (fs *S3Fs) IsLocal() bool
  • func (fs *S3Fs) Protocol() string
  • func (fs *S3Fs) String() string

Functions

func FileExists

func FileExists(filename string) bool

func FolderExists

func FolderExists(filename string) bool

func IsNotFoundError

func IsNotFoundError(err error) bool

Types

type FileGetOptions

type FileGetOptions struct {
	VersionID string
}

GetObjectOptions represents options specified by user for GetObject call

type FilePutOptions

type FilePutOptions struct {
	Progress    io.Reader
	ContentType string
}

PutObjectOptions represents options specified by user for PutObject call

type FileStatOptions

type FileStatOptions struct {
}

type FileSystem

type FileSystem interface {
	BucketExists(folder string) (bool, error)
	BucketCreate(folder string, opts FolderCreateOptions) error
	GETUrl(folder, name string, valid time.Duration) (*url.URL, error)
	FileExists(folder, name string) (bool, error)
	FileGet(folder, name string, opts FileGetOptions) ([]byte, error)
	FilePut(folder, name string, data []byte, opts FilePutOptions) error
	FileWrite(folder, name string, r io.Reader, size int64, opts FilePutOptions) error
	FileRead(folder, name string, w io.Writer, size int64, opts FileGetOptions) error
	FileOpenRead(folder, name string, opts FileGetOptions) (ReadSeekerCloser, os.FileInfo, error)
	FileStat(folder, name string, opts FileStatOptions) (os.FileInfo, error)
	String() string
	Protocol() string
	IsLocal() bool
}

type FolderCreateOptions

type FolderCreateOptions struct {
	ObjectLocking bool
}

type LocalFs

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

func NewLocalFs

func NewLocalFs(name, basepath string, logger *logging.Logger) (*LocalFs, error)

func (*LocalFs) BucketCreate

func (fs *LocalFs) BucketCreate(folder string, opts FolderCreateOptions) error

func (*LocalFs) BucketExists

func (fs *LocalFs) BucketExists(folder string) (bool, error)

func (*LocalFs) FileExists

func (fs *LocalFs) FileExists(folder, name string) (bool, error)

func (*LocalFs) FileGet

func (fs *LocalFs) FileGet(folder, name string, opts FileGetOptions) ([]byte, error)

func (*LocalFs) FileOpenRead

func (fs *LocalFs) FileOpenRead(folder, name string, opts FileGetOptions) (ReadSeekerCloser, os.FileInfo, error)

func (*LocalFs) FilePut

func (fs *LocalFs) FilePut(folder, name string, data []byte, opts FilePutOptions) error

func (*LocalFs) FileRead

func (fs *LocalFs) FileRead(folder, name string, w io.Writer, size int64, opts FileGetOptions) error

func (*LocalFs) FileStat

func (fs *LocalFs) FileStat(folder, name string, opts FileStatOptions) (os.FileInfo, error)

func (*LocalFs) FileWrite

func (fs *LocalFs) FileWrite(folder, name string, r io.Reader, size int64, opts FilePutOptions) error

func (*LocalFs) GETUrl

func (fs *LocalFs) GETUrl(folder, name string, valid time.Duration) (*url.URL, error)

func (*LocalFs) IsLocal

func (fs *LocalFs) IsLocal() bool

func (*LocalFs) Protocol

func (fs *LocalFs) Protocol() string

func (*LocalFs) String

func (fs *LocalFs) String() string

type NotFoundError

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

func (*NotFoundError) Error

func (nf *NotFoundError) Error() string

type ReadSeekerCloser

type ReadSeekerCloser interface {
	io.Reader
	io.Seeker
	io.Closer
}

type S3FileInfo

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

A FileInfo describes a file and is returned by Stat and Lstat.

func NewS3FileInfo

func NewS3FileInfo(bucket, name string, info minio.ObjectInfo) *S3FileInfo

func (*S3FileInfo) IsDir

func (sfi *S3FileInfo) IsDir() bool

func (*S3FileInfo) ModTime

func (sfi *S3FileInfo) ModTime() time.Time

func (*S3FileInfo) Mode

func (sfi *S3FileInfo) Mode() os.FileMode

func (*S3FileInfo) Name

func (sfi *S3FileInfo) Name() string

func (*S3FileInfo) Size

func (sfi *S3FileInfo) Size() int64

func (*S3FileInfo) Sys

func (sfi *S3FileInfo) Sys() interface{}

type S3Fs

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

func NewS3Fs

func NewS3Fs(name,
	endpoint string,
	accessKeyId string,
	secretAccessKey string,
	useSSL bool) (*S3Fs, error)

func (*S3Fs) BucketCreate

func (fs *S3Fs) BucketCreate(folder string, opts FolderCreateOptions) error

func (*S3Fs) BucketExists

func (fs *S3Fs) BucketExists(folder string) (bool, error)

func (*S3Fs) FileExists

func (fs *S3Fs) FileExists(folder, name string) (bool, error)

func (*S3Fs) FileGet

func (fs *S3Fs) FileGet(folder, name string, opts FileGetOptions) ([]byte, error)

func (*S3Fs) FileOpenRead

func (fs *S3Fs) FileOpenRead(folder, name string, opts FileGetOptions) (ReadSeekerCloser, os.FileInfo, error)

func (*S3Fs) FilePut

func (fs *S3Fs) FilePut(folder, name string, data []byte, opts FilePutOptions) error

func (*S3Fs) FileRead

func (fs *S3Fs) FileRead(folder, name string, w io.Writer, size int64, opts FileGetOptions) error

func (*S3Fs) FileStat

func (fs *S3Fs) FileStat(folder, name string, opts FileStatOptions) (os.FileInfo, error)

func (*S3Fs) FileWrite

func (fs *S3Fs) FileWrite(folder, name string, r io.Reader, size int64, opts FilePutOptions) error

func (*S3Fs) GETUrl

func (fs *S3Fs) GETUrl(folder, name string, valid time.Duration) (*url.URL, error)

func (*S3Fs) IsLocal

func (fs *S3Fs) IsLocal() bool

func (*S3Fs) Protocol

func (fs *S3Fs) Protocol() string

func (*S3Fs) String

func (fs *S3Fs) String() string