ftp

README

ftp

FTP service support for go-storage.

Install

go get go.beyondstorage.io/services/ftp

Usage

import (
	"log"

	_ "go.beyondstorage.io/services/ftp"
	"github.com/fastone-open/go-storage/services"
)

func main() {
	store, err := services.NewStoragerFromString("ftp:///path/to/workdir?credential=basic:<user>:<password>&endpoint=tcp:<host>:<port>")
	if err != nil {
		log.Fatal(err)
	}

	// Write data from io.Reader into hello.txt
	n, err := store.Write("hello.txt", r, length)
}

• See more examples in go-storage-example.
• Read more docs about go-service-ftp.

Documentation

Overview

Package ftp provided support for ftp by go-storage.

Code generated by go generate via cmd/definitions; DO NOT EDIT.

Index

• Constants
• func NewStorager(pairs ...types.Pair) (types.Storager, error)
• func WithDefaultStoragePairs(v DefaultStoragePairs) Pair
• func WithStorageFeatures(v StorageFeatures) Pair
• type ObjectSystemMetadata
  • func GetObjectSystemMetadata(o *Object) ObjectSystemMetadata
• type Storage
  • func (s *Storage) Create(path string, pairs ...Pair) (o *Object)
  • func (s *Storage) Delete(path string, pairs ...Pair) (err error)
  • func (s *Storage) DeleteWithContext(ctx context.Context, path string, pairs ...Pair) (err error)
  • func (s *Storage) List(path string, pairs ...Pair) (oi *ObjectIterator, err error)
  • func (s *Storage) ListWithContext(ctx context.Context, path string, pairs ...Pair) (oi *ObjectIterator, err error)
  • func (s *Storage) Metadata(pairs ...Pair) (meta *StorageMeta)
  • func (s *Storage) Read(path string, w io.Writer, pairs ...Pair) (n int64, err error)
  • func (s *Storage) ReadWithContext(ctx context.Context, path string, w io.Writer, pairs ...Pair) (n int64, err error)
  • func (s *Storage) Stat(path string, pairs ...Pair) (o *Object, err error)
  • func (s *Storage) StatWithContext(ctx context.Context, path string, pairs ...Pair) (o *Object, err error)
  • func (s *Storage) String() string
  • func (s *Storage) Write(path string, r io.Reader, size int64, pairs ...Pair) (n int64, err error)
  • func (s *Storage) WriteWithContext(ctx context.Context, path string, r io.Reader, size int64, pairs ...Pair) (n int64, err error)
• type StorageSystemMetadata
  • func GetStorageSystemMetadata(s *StorageMeta) StorageSystemMetadata

Constants

const Type = "ftp"

Type is the type for ftp

Functions

func NewStorager

func NewStorager(pairs ...types.Pair) (types.Storager, error)

NewStorager will create Storager only.

func WithDefaultStoragePairs

func WithDefaultStoragePairs(v DefaultStoragePairs) Pair

WithDefaultStoragePairs will apply default_storage_pairs value to Options.

func WithStorageFeatures

func WithStorageFeatures(v StorageFeatures) Pair

WithStorageFeatures will apply storage_features value to Options.

Types

type ObjectSystemMetadata

type ObjectSystemMetadata struct {
}

ObjectSystemMetadata stores system metadata for object.

func GetObjectSystemMetadata

func GetObjectSystemMetadata(o *Object) ObjectSystemMetadata

GetObjectSystemMetadata will get ObjectSystemMetadata from Object.

- This function should not be called by service implementer. - The returning ObjectServiceMetadata is read only and should not be modified.

type Storage

type Storage struct {
	types.UnimplementedStorager
	// contains filtered or unexported fields
}

Storage is the example client.

func (*Storage) Create

func (s *Storage) Create(path string, pairs ...Pair) (o *Object)

func (*Storage) Delete

func (s *Storage) Delete(path string, pairs ...Pair) (err error)

func (*Storage) DeleteWithContext

func (s *Storage) DeleteWithContext(ctx context.Context, path string, pairs ...Pair) (err error)

func (*Storage) List

func (s *Storage) List(path string, pairs ...Pair) (oi *ObjectIterator, err error)

func (*Storage) ListWithContext

func (s *Storage) ListWithContext(ctx context.Context, path string, pairs ...Pair) (oi *ObjectIterator, err error)

func (*Storage) Metadata

func (s *Storage) Metadata(pairs ...Pair) (meta *StorageMeta)

func (*Storage) Read

func (s *Storage) Read(path string, w io.Writer, pairs ...Pair) (n int64, err error)

func (*Storage) ReadWithContext

func (s *Storage) ReadWithContext(ctx context.Context, path string, w io.Writer, pairs ...Pair) (n int64, err error)

func (*Storage) Stat

func (s *Storage) Stat(path string, pairs ...Pair) (o *Object, err error)

func (*Storage) StatWithContext

func (s *Storage) StatWithContext(ctx context.Context, path string, pairs ...Pair) (o *Object, err error)

func (*Storage) String

func (s *Storage) String() string

String implements Storager.String

func (*Storage) Write

func (s *Storage) Write(path string, r io.Reader, size int64, pairs ...Pair) (n int64, err error)

func (*Storage) WriteWithContext

func (s *Storage) WriteWithContext(ctx context.Context, path string, r io.Reader, size int64, pairs ...Pair) (n int64, err error)

type StorageSystemMetadata

type StorageSystemMetadata struct {
}

StorageSystemMetadata stores system metadata for object.

func GetStorageSystemMetadata

func GetStorageSystemMetadata(s *StorageMeta) StorageSystemMetadata

GetStorageSystemMetadata will get StorageSystemMetadata from Storage.

- This function should not be called by service implementer. - The returning StorageServiceMetadata is read only and should not be modified.