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

package yandex

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

Index

Package Files

yandex.go

func NewFs Uses

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

NewFs constructs an Fs from the path, container:path

type Fs Uses

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

Fs represents a remote yandex

func (*Fs) About Uses

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

About gets quota information

func (*Fs) CleanUp Uses

❖
func (f *Fs) CleanUp(ctx context.Context) (err error)

CleanUp permanently deletes all trashed files/folders

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) CreateDir Uses

❖
func (f *Fs) CreateDir(path string) (err error)

CreateDir makes a directory

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 the supported hash sets.

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) Mkdir Uses

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

Mkdir creates the container if it doesn't exist

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 finds the Object at remote. If it can't be found it returns the error fs.ErrorObjectNotFound.

func (*Fs) Precision Uses

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

Precision return the precision of this Fs

❖
func (f *Fs) PublicLink(ctx context.Context, remote string) (link string, err error)

PublicLink generates a public link to the remote path (usually readable by anyone)

func (*Fs) Purge Uses

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

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

Put the object

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) 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

func (*Fs) Rmdir Uses

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

Rmdir deletes the container

Returns an error if it isn't empty

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 {
    // contains filtered or unexported fields
}

Object describes a swift object

func (*Object) Fs Uses

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

Fs returns the parent Fs

func (*Object) Hash Uses

❖
func (o *Object) Hash(ctx context.Context, t hash.Type) (string, error)

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

func (*Object) MimeType Uses

❖
func (o *Object) MimeType(ctx context.Context) string

MimeType of an Object if known, "" otherwise

func (*Object) ModTime Uses

❖
func (o *Object) ModTime(ctx context.Context) 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 Uses

❖
func (o *Object) Open(ctx context.Context, options ...fs.OpenOption) (in io.ReadCloser, err error)

Open an object for read

func (*Object) Remote Uses

❖
func (o *Object) Remote() string

Remote returns the remote path

func (*Object) Remove Uses

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

Remove an object

func (*Object) SetModTime Uses

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

SetModTime sets the modification time of the local fs object

Commits the datastore

func (*Object) Size Uses

❖
func (o *Object) Size() int64

Size returns the size of an object in bytes

func (*Object) Storable Uses

❖
func (o *Object) Storable() bool

Storable returns whether this object is storable

func (*Object) String Uses

❖
func (o *Object) String() string

Return a string version

func (*Object) Update Uses

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

Update the already existing object

Copy the reader into the object updating modTime and size

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

type Options Uses

❖
type Options struct {
    Token  string `config:"token"`
    Unlink bool   `config:"unlink"`
}

Options defines the configuration for this backend

Directories

PathSynopsis
api

Package yandex imports 25 packages (graph) and is imported by 1 packages. Updated 2019-08-17. Refresh now. Tools for package owners.