files

Documentation

Index

• type Local
  • func NewLocal(basePath string, maxSize int) (*Local, error)
  • func (l *Local) FullPath(path string) string
  • func (l *Local) Get(path string) (*os.File, error)
  • func (l *Local) Save(path string, contents io.Reader) error
  • func (l *Local) Unbundle(src, dest string) error
• type Storage

Types

type Local

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

Local is an implementation of the Storage interface which works with the local disk on the current machine

func NewLocal

func NewLocal(basePath string, maxSize int) (*Local, error)

NewLocal creates a new Local filesytem with the given base path basePath is the base directory to save files to maxSize is the max number of bytes that a file can be

func (*Local) FullPath

func (l *Local) FullPath(path string) string

FullPath returns the absolute path

func (*Local) Get

func (l *Local) Get(path string) (*os.File, error)

Get the file at the given path and return a Reader the calling function is responsible for closing the reader

func (*Local) Save

func (l *Local) Save(path string, contents io.Reader) error

Save the contents of the Writer to the given path path is a relative path, basePath will be appended

func (*Local) Unbundle

func (l *Local) Unbundle(src, dest string) error

Unbundle is cloning a bundle to the dest directory

type Storage

type Storage interface {
	Save(path string, file io.Reader) error
	FullPath(path string) string
	Unbundle(src, dest string) error
}

Storage defines the behavior for file operations Implementations may be of the time local disk, or cloud storage, etc