rclone: github.com/ncw/rclone/backend/ftp Index | Files

package ftp

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

Package ftp interfaces with FTP servers


Package Files


func NewFs Uses

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

NewFs constructs an Fs from the path, container:path

type FileInfo Uses

type FileInfo struct {
    Name    string
    Size    uint64
    ModTime time.Time
    IsDir   bool

FileInfo is the metadata known about an FTP file

type Fs Uses

type Fs struct {
    // contains filtered or unexported fields

Fs represents a remote FTP server

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 are not supported

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) (err error)

Mkdir creates the directory 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 renames a remote file object

func (*Fs) Name Uses

func (f *Fs) Name() string

Name of this fs

func (*Fs) NewObject Uses

func (f *Fs) NewObject(ctx context.Context, remote string) (o fs.Object, err 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 shows Modified Time not supported

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

func (*Fs) Rmdir Uses

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

Rmdir removes the directory (container, bucket) if empty

Return an error if it doesn't exist or 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 returns a description of the FS

type Object Uses

type Object struct {
    // contains filtered or unexported fields

Object describes an FTP file

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 hash of an object returning a lowercase hex string

func (*Object) ModTime Uses

func (o *Object) ModTime(ctx context.Context) time.Time

ModTime returns the modification time of the object

func (*Object) Open Uses

func (o *Object) Open(ctx context.Context, options ...fs.OpenOption) (rc 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) (err 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 object

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 a boolean as to whether this object is storable

func (*Object) String Uses

func (o *Object) String() string

String version of o

func (*Object) Update Uses

func (o *Object) Update(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (err 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 {
    Host              string               `config:"host"`
    User              string               `config:"user"`
    Pass              string               `config:"pass"`
    Port              string               `config:"port"`
    TLS               bool                 `config:"tls"`
    ExplicitTLS       bool                 `config:"explicit_tls"`
    Concurrency       int                  `config:"concurrency"`
    SkipVerifyTLSCert bool                 `config:"no_check_certificate"`
    DisableEPSV       bool                 `config:"disable_epsv"`
    Enc               encoder.MultiEncoder `config:"encoding"`

Options defines the configuration for this backend

Package ftp imports 21 packages (graph) and is imported by 2 packages. Updated 2020-07-28. Refresh now. Tools for package owners.