rclone: github.com/ncw/rclone/backend/union Index | Files | Directories

package union

import "github.com/ncw/rclone/backend/union"

Index

Package Files

entry.go errors.go union.go

func NewFs Uses

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

NewFs constructs an Fs from the path.

The returned Fs is the actual Fs, referenced by remote in the config

type Directory Uses

type Directory struct {
    *upstream.Directory
    // contains filtered or unexported fields
}

Directory describes a union Directory

This is a wrapped object contains all candidates

func (*Directory) ModTime Uses

func (d *Directory) ModTime(ctx context.Context) (t time.Time)

ModTime returns the modification date of the directory It returns the latest ModTime of all candidates

func (*Directory) Size Uses

func (d *Directory) Size() (s int64)

Size returns the size of the directory It returns the sum of all candidates

type Errors Uses

type Errors []error

The Errors type wraps a slice of errors

func (Errors) Err Uses

func (e Errors) Err() error

Err returns an error interface that filtered nil, or nil if no non-nil Error is presented.

func (Errors) Error Uses

func (e Errors) Error() string

Error returns a concatenated string of the contained errors

func (Errors) FilterNil Uses

func (e Errors) FilterNil() Errors

FilterNil returns the Errors without nil

func (Errors) Map Uses

func (e Errors) Map(mapping func(error) error) Errors

Map returns a copy of the error slice with all its errors modified according to the mapping function. If mapping returns nil, the error is dropped from the error slice with no replacement.

type Fs Uses

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

Fs represents a union of upstreams

func (*Fs) About Uses

func (f *Fs) About(ctx context.Context) (*fs.Usage, error)

About gets quota information from the Fs

func (*Fs) ChangeNotify Uses

func (f *Fs) ChangeNotify(ctx context.Context, fn func(string, fs.EntryType), ch <-chan time.Duration)

ChangeNotify calls the passed function with a path that has had changes. If the implementation uses polling, it should adhere to the given interval. At least one value will be written to the channel, specifying the initial value and updated values might follow. A 0 Duration should pause the polling. The ChangeNotify implementation must empty the channel regularly. When the channel gets closed, the implementation should stop polling and release resources.

func (*Fs) Copy Uses

func (f *Fs) Copy(ctx context.Context, src fs.Object, remote string) (fs.Object, error)

Copy src to this remote using server side copy 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.ErrorCantCopy

func (*Fs) DirCacheFlush Uses

func (f *Fs) DirCacheFlush()

DirCacheFlush resets the directory cache - used in testing as an optional interface

func (*Fs) DirMove Uses

func (f *Fs) DirMove(ctx context.Context, src fs.Fs, srcRemote, dstRemote string) error

DirMove moves src, srcRemote to this remote at dstRemote 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) Features Uses

func (f *Fs) Features() *fs.Features

Features returns the optional features of this Fs

func (*Fs) Hashes Uses

func (f *Fs) Hashes() hash.Set

Hashes returns hash.HashNone to indicate remote hashing is unavailable

func (*Fs) List Uses

func (f *Fs) List(ctx context.Context, dir string) (entries fs.DirEntries, err error)

List the objects and directories in dir into entries. The entries can be returned in any order but should be for a complete directory.

dir should be "" to list the root, and should not have trailing slashes.

This should return ErrDirNotFound if the directory isn't found.

func (*Fs) ListR Uses

func (f *Fs) ListR(ctx context.Context, dir string, callback fs.ListRCallback) (err error)

ListR lists the objects and directories of the Fs starting from dir recursively into out.

dir should be "" to start from the root, and should not have trailing slashes.

This should return ErrDirNotFound if the directory isn't found.

It should call callback for each tranche of entries read. These need not be returned in any particular order. If callback returns an error then the listing will stop immediately.

Don't implement this unless you have a more efficient way of listing recursively that doing a directory traversal.

func (*Fs) Mkdir Uses

func (f *Fs) Mkdir(ctx context.Context, dir string) error

Mkdir makes the root directory of the Fs object

func (*Fs) Move Uses

func (f *Fs) Move(ctx context.Context, 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 Uses

func (f *Fs) Name() string

Name of the remote (as passed into NewFs)

func (*Fs) NewObject Uses

func (f *Fs) NewObject(ctx context.Context, remote string) (fs.Object, error)

NewObject creates a new remote union file object

func (*Fs) Precision Uses

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

Precision is the greatest Precision of all upstreams

func (*Fs) Purge Uses

func (f *Fs) Purge(ctx context.Context, dir string) error

Purge all files in the directory

Implement this if you have a way of deleting all the files quicker than just running Remove() on the result of List()

Return an error if it doesn't exist

func (*Fs) Put Uses

func (f *Fs) Put(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)

Put in to the remote path with the modTime given of the given size

May create the object even if it returns an error - if so will return the object and the error, otherwise will return nil and the error

func (*Fs) PutStream Uses

func (f *Fs) PutStream(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)

PutStream uploads to the remote path with the modTime given of indeterminate size

May create the object even if it returns an error - if so will return the object and the error, otherwise will return nil and the error

func (*Fs) Rmdir Uses

func (f *Fs) Rmdir(ctx context.Context, dir string) error

Rmdir removes the root directory of the Fs object

func (*Fs) Root Uses

func (f *Fs) Root() string

Root of the remote (as passed into NewFs)

func (*Fs) String Uses

func (f *Fs) String() string

String converts this Fs to a string

type Object Uses

type Object struct {
    *upstream.Object
    // contains filtered or unexported fields
}

Object describes a union Object

This is a wrapped object which returns the Union Fs as its parent

func (*Object) Fs Uses

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

Fs returns the union Fs as the parent

func (*Object) Remove Uses

func (o *Object) Remove(ctx context.Context) error

Remove candidate objects selected by ACTION policy

func (*Object) SetModTime Uses

func (o *Object) SetModTime(ctx context.Context, t time.Time) error

SetModTime sets the metadata on the object to set the modification date

func (*Object) UnWrap Uses

func (o *Object) UnWrap() *upstream.Object

UnWrap returns the Object that this Object is wrapping or nil if it isn't wrapping anything

func (*Object) Update Uses

func (o *Object) Update(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) error

Update in to the object with the modTime given of the given size

When called from outside an Fs by rclone, src.Size() will always be >= 0. But for unknown-sized objects (indicated by src.Size() == -1), Upload should either return an error or update the object properly (rather than e.g. calling panic).

type Options Uses

type Options struct {
    Upstreams    fs.SpaceSepList `config:"upstreams"`
    Remotes      fs.SpaceSepList `config:"remotes"` // Depreated
    ActionPolicy string          `config:"action_policy"`
    CreatePolicy string          `config:"create_policy"`
    SearchPolicy string          `config:"search_policy"`
    CacheTime    int             `config:"cache_time"`
}

Options defines the configuration for this backend

Directories

PathSynopsis
policy
upstream

Package union imports 19 packages (graph). Updated 2020-09-21. Refresh now. Tools for package owners.