amazonclouddrive

Documentation

Overview

Package amazonclouddrive provides an interface to the Amazon Cloud Drive object storage system.

Index

• func NewFs(name, root string) (fs.Fs, error)
• type Fs
  • func (f *Fs) CreateDir(pathID, leaf string) (newID string, err error)
  • func (f *Fs) FindLeaf(pathID, leaf string) (pathIDOut string, found bool, err error)
  • func (f *Fs) List() fs.ObjectsChan
  • func (f *Fs) ListDir() fs.DirChan
  • func (f *Fs) Mkdir() error
  • func (f *Fs) Name() string
  • func (f *Fs) NewFsObject(remote string) fs.Object
  • func (f *Fs) 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, container:path

Types

type Fs

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

Fs represents a remote acd server

func (*Fs) CreateDir

func (f *Fs) CreateDir(pathID, leaf string) (newID string, err error)

CreateDir makes a directory with pathID as parent and name leaf

func (*Fs) FindLeaf

func (f *Fs) FindLeaf(pathID, leaf string) (pathIDOut string, found bool, err error)

FindLeaf finds a directory of name leaf in the folder with ID pathID

func (*Fs) List

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

List walks the path returning a channel of FsObjects

func (*Fs) ListDir

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

ListDir lists the directories

func (*Fs) Mkdir

func (f *Fs) Mkdir() error

Mkdir creates the container if it doesn't exist

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() time.Duration

Precision return the precision of this Fs

func (*Fs) Purge

func (f *Fs) Purge() error

Purge deletes all the files and the container

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 object into the container

Copy the reader in to the new object which is returned

The new object may have been created if an error is returned

func (*Fs) Rmdir

func (f *Fs) Rmdir() error

Rmdir deletes the root folder

Returns an error if it isn't empty

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 describes a acd object

Will definitely have info but maybe not meta

func (*Object) Fs

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

Fs returns the parent Fs

func (*Object) Md5sum

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

Md5sum returns the Md5sum of an object returning a lowercase hex string

func (*Object) ModTime

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

ModTime returns the modification time of the object

It attempts to read the objects mtime and if that isn't present the LastModified returned in the http headers

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 whether this object 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 with the contents of the io.Reader, modTime and size

The new object may have been created if an error is returned