local

Documentation

Overview

Package local provides a filesystem interface

Index

• func NewFs(name, root string) (fs.Fs, error)
• type Fs
  • func (f *Fs) DirMove(src fs.Fs) error
  • func (f *Fs) List() fs.ObjectsChan
  • func (f *Fs) ListDir() fs.DirChan
  • func (f *Fs) Mkdir() error
  • func (f *Fs) Move(src fs.Object, remote string) (fs.Object, error)
  • func (f *Fs) Name() string
  • func (f *Fs) NewFsObject(remote string) fs.Object
  • func (f *Fs) Precision() (precision time.Duration)
  • func (f *Fs) Purge() error
  • func (f *Fs) Put(in io.Reader, remote string, modTime time.Time, size int64) (fs.Object, error)
  • func (f *Fs) Rmdir() error
  • func (f *Fs) Root() string
  • func (f *Fs) String() string
• type Object
  • func (o *Object) Fs() fs.Fs
  • func (o *Object) Md5sum() (string, error)
  • func (o *Object) ModTime() time.Time
  • func (o *Object) Open() (in io.ReadCloser, err error)
  • func (o *Object) Remote() string
  • func (o *Object) Remove() error
  • func (o *Object) SetModTime(modTime time.Time)
  • func (o *Object) Size() int64
  • func (o *Object) Storable() bool
  • func (o *Object) String() string
  • func (o *Object) Update(in io.Reader, modTime time.Time, size int64) error

Functions

func NewFs

func NewFs(name, root string) (fs.Fs, error)

NewFs constructs an Fs from the path

Types

type Fs

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

Fs represents a local filesystem rooted at root

func (*Fs) DirMove

func (f *Fs) DirMove(src fs.Fs) error

DirMove moves src directory to this remote using server side move operations.

Will only be called if src.Fs().Name() == f.Name()

If it isn't possible then return fs.ErrorCantDirMove

If destination exists then return fs.ErrorDirExists

func (*Fs) List

func (f *Fs) List() fs.ObjectsChan

List the path returning a channel of FsObjects

Ignores everything which isn't Storable, eg links etc

func (*Fs) ListDir

func (f *Fs) ListDir() fs.DirChan

ListDir walks the path returning a channel of FsObjects

func (*Fs) Mkdir

func (f *Fs) Mkdir() error

Mkdir creates the directory if it doesn't exist

func (*Fs) Move

func (f *Fs) Move(src fs.Object, remote string) (fs.Object, error)

Move src to this remote using server side move operations.

This is stored with the remote path given

It returns the destination Object and a possible error

Will only be called if src.Fs().Name() == f.Name()

If it isn't possible then return fs.ErrorCantMove

func (*Fs) Name

func (f *Fs) Name() string

Name of the remote (as passed into NewFs)

func (*Fs) NewFsObject

func (f *Fs) NewFsObject(remote string) fs.Object

NewFsObject returns an FsObject from a path

May return nil if an error occurred

func (*Fs) Precision

func (f *Fs) Precision() (precision time.Duration)

Precision of the file system

func (*Fs) Purge

func (f *Fs) Purge() error

Purge deletes all the files and directories

Optional interface: Only implement this if you have a way of deleting all the files quicker than just running Remove() on the result of List()

func (*Fs) Put

func (f *Fs) Put(in io.Reader, remote string, modTime time.Time, size int64) (fs.Object, error)

Put the FsObject to the local filesystem

func (*Fs) Rmdir

func (f *Fs) Rmdir() error

Rmdir removes the directory

If it isn't empty it will return an error

func (*Fs) Root

func (f *Fs) Root() string

Root of the remote (as passed into NewFs)

func (*Fs) String

func (f *Fs) String() string

String converts this Fs to a string

type Object

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

Object represents a local filesystem object

func (*Object) Fs

func (o *Object) Fs() fs.Fs

Fs returns the parent Fs

func (*Object) Md5sum

func (o *Object) Md5sum() (string, error)

Md5sum calculates the Md5sum of a file returning a lowercase hex string

func (*Object) ModTime

func (o *Object) ModTime() time.Time

ModTime returns the modification time of the object

func (*Object) Open

func (o *Object) Open() (in io.ReadCloser, err error)

Open an object for read

func (*Object) Remote

func (o *Object) Remote() string

Remote returns the remote path

func (*Object) Remove

func (o *Object) Remove() error

Remove an object

func (*Object) SetModTime

func (o *Object) SetModTime(modTime time.Time)

SetModTime sets the modification time of the local fs object

func (*Object) Size

func (o *Object) Size() int64

Size returns the size of an object in bytes

func (*Object) Storable

func (o *Object) Storable() bool

Storable returns a boolean showing if this object is storable

func (*Object) String

func (o *Object) String() string

Return a string version

func (*Object) Update

func (o *Object) Update(in io.Reader, modTime time.Time, size int64) error

Update the object from in with modTime and size