s3

Documentation

Index

• func Create(ctx context.Context, cfg Config, rt http.RoundTripper) (backend.Backend, error)
• func NewFactory() location.Factory
• func Open(ctx context.Context, cfg Config, rt http.RoundTripper) (backend.Backend, error)
• type Backend
  • func (be *Backend) Close() error
  • func (be *Backend) Connections() uint
  • func (be *Backend) Delete(ctx context.Context) error
  • func (be *Backend) HasAtomicReplace() bool
  • func (be *Backend) Hasher() hash.Hash
  • func (be *Backend) IsNotExist(err error) bool
  • func (be *Backend) Join(p ...string) string
  • func (be *Backend) List(ctx context.Context, t backend.FileType, fn func(backend.FileInfo) error) error
  • func (be *Backend) Load(ctx context.Context, h backend.Handle, length int, offset int64, ...) error
  • func (be *Backend) Location() string
  • func (be *Backend) Path() string
  • func (be *Backend) ReadDir(ctx context.Context, dir string) (list []os.FileInfo, err error)
  • func (be *Backend) Remove(ctx context.Context, h backend.Handle) error
  • func (be *Backend) Rename(ctx context.Context, h backend.Handle, l layout.Layout) error
  • func (be *Backend) Save(ctx context.Context, h backend.Handle, rd backend.RewindReader) error
  • func (be *Backend) Stat(ctx context.Context, h backend.Handle) (bi backend.FileInfo, err error)
• type Config
  • func NewConfig() Config
  • func ParseConfig(s string) (*Config, error)
  • func (cfg *Config) ApplyEnvironment(prefix string)

Functions

func Create

func Create(ctx context.Context, cfg Config, rt http.RoundTripper) (backend.Backend, error)

Create opens the S3 backend at bucket and region and creates the bucket if it does not exist yet.

func NewFactory

func NewFactory() location.Factory

func Open

func Open(ctx context.Context, cfg Config, rt http.RoundTripper) (backend.Backend, error)

Open opens the S3 backend at bucket and region. The bucket is created if it does not exist yet.

Types

type Backend

type Backend struct {
	layout.Layout
	// contains filtered or unexported fields
}

Backend stores data on an S3 endpoint.

func (*Backend) Close

func (be *Backend) Close() error

Close does nothing

func (*Backend) Connections

func (be *Backend) Connections() uint

func (*Backend) Delete

func (be *Backend) Delete(ctx context.Context) error

Delete removes all restic keys in the bucket. It will not remove the bucket itself.

func (*Backend) HasAtomicReplace

func (be *Backend) HasAtomicReplace() bool

HasAtomicReplace returns whether Save() can atomically replace files

func (*Backend) Hasher

func (be *Backend) Hasher() hash.Hash

Hasher may return a hash function for calculating a content hash for the backend

func (*Backend) IsNotExist

func (be *Backend) IsNotExist(err error) bool

IsNotExist returns true if the error is caused by a not existing file.

func (*Backend) Join

func (be *Backend) Join(p ...string) string

Join combines path components with slashes.

func (*Backend) List

func (be *Backend) List(ctx context.Context, t backend.FileType, fn func(backend.FileInfo) error) error

List runs fn for each file in the backend which has the type t. When an error occurs (or fn returns an error), List stops and returns it.

func (*Backend) Load

func (be *Backend) Load(ctx context.Context, h backend.Handle, length int, offset int64, fn func(rd io.Reader) error) error

Load runs fn with a reader that yields the contents of the file at h at the given offset.

func (*Backend) Location

func (be *Backend) Location() string

Location returns this backend's location (the bucket name).

func (*Backend) Path

func (be *Backend) Path() string

Path returns the path in the bucket that is used for this backend.

func (*Backend) ReadDir

func (be *Backend) ReadDir(ctx context.Context, dir string) (list []os.FileInfo, err error)

ReadDir returns the entries for a directory.

func (*Backend) Remove

func (be *Backend) Remove(ctx context.Context, h backend.Handle) error

Remove removes the blob with the given name and type.

func (*Backend) Rename

func (be *Backend) Rename(ctx context.Context, h backend.Handle, l layout.Layout) error

Rename moves a file based on the new layout l.

func (*Backend) Save

func (be *Backend) Save(ctx context.Context, h backend.Handle, rd backend.RewindReader) error

Save stores data in the backend at the handle.

func (*Backend) Stat

func (be *Backend) Stat(ctx context.Context, h backend.Handle) (bi backend.FileInfo, err error)

Stat returns information about a blob.

type Config

type Config struct {
	Endpoint     string
	UseHTTP      bool
	KeyID        string
	Secret       options.SecretString
	Bucket       string
	Prefix       string
	Layout       string `option:"layout" help:"use this backend layout (default: auto-detect)"`
	StorageClass string `` /* 129-byte string literal not displayed */

	Connections   uint   `option:"connections" help:"set a limit for the number of concurrent connections (default: 5)"`
	MaxRetries    uint   `option:"retries" help:"set the number of retries attempted"`
	Region        string `option:"region" help:"set region"`
	BucketLookup  string `option:"bucket-lookup" help:"bucket lookup style: 'auto', 'dns', or 'path'"`
	ListObjectsV1 bool   `option:"list-objects-v1" help:"use deprecated V1 api for ListObjects calls"`
}

Config contains all configuration necessary to connect to an s3 compatible server.

func NewConfig

func NewConfig() Config

NewConfig returns a new Config with the default values filled in.

func ParseConfig

func ParseConfig(s string) (*Config, error)

ParseConfig parses the string s and extracts the s3 config. The two supported configuration formats are s3://host/bucketname/prefix and s3:host/bucketname/prefix. The host can also be a valid s3 region name. If no prefix is given the prefix "restic" will be used.

func (*Config) ApplyEnvironment

func (cfg *Config) ApplyEnvironment(prefix string)

ApplyEnvironment saves values from the environment to the config.