rest

Documentation

Index

• Constants
• func ParseConfig(s string) (interface{}, error)
• func StripPassword(s string) string
• type Backend
  • func Create(ctx context.Context, cfg Config, rt http.RoundTripper) (*Backend, error)
  • func Open(cfg Config, rt http.RoundTripper) (*Backend, error)
  • func (b *Backend) Close() error
  • func (b *Backend) Delete(ctx context.Context) error
  • func (b *Backend) IsNotExist(err error) bool
  • func (b *Backend) List(ctx context.Context, t restic.FileType, fn func(restic.FileInfo) error) error
  • func (b *Backend) Load(ctx context.Context, h restic.Handle, length int, offset int64, ...) error
  • func (b *Backend) Location() string
  • func (b *Backend) Remove(ctx context.Context, h restic.Handle) error
  • func (b *Backend) Save(ctx context.Context, h restic.Handle, rd restic.RewindReader) error
  • func (b *Backend) Stat(ctx context.Context, h restic.Handle) (restic.FileInfo, error)
  • func (b *Backend) Test(ctx context.Context, h restic.Handle) (bool, error)
• type Config
  • func NewConfig() Config
• type ErrIsNotExist
  • func (e ErrIsNotExist) Error() string

Constants

const (
	ContentTypeV1 = "application/vnd.x.restic.rest.v1"
	ContentTypeV2 = "application/vnd.x.restic.rest.v2"
)

the REST API protocol version is decided by HTTP request headers, these are the constants.

Functions

func ParseConfig

func ParseConfig(s string) (interface{}, error)

ParseConfig parses the string s and extracts the REST server URL.

func StripPassword

func StripPassword(s string) string

StripPassword removes the password from the URL If the repository location cannot be parsed as a valid URL, it will be returned as is (it's because this function is used for logging errors)

Types

type Backend

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

Backend uses the REST protocol to access data stored on a server.

func Create

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

Create creates a new REST on server configured in config.

func Open

func Open(cfg Config, rt http.RoundTripper) (*Backend, error)

Open opens the REST backend with the given config.

func (*Backend) Close

func (b *Backend) Close() error

Close closes all open files.

func (*Backend) Delete

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

Delete removes all data in the backend.

func (*Backend) IsNotExist

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

IsNotExist returns true if the error was caused by a non-existing file.

func (*Backend) List

func (b *Backend) List(ctx context.Context, t restic.FileType, fn func(restic.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 (b *Backend) Load(ctx context.Context, h restic.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 (b *Backend) Location() string

Location returns this backend's location (the server's URL).

func (*Backend) Remove

func (b *Backend) Remove(ctx context.Context, h restic.Handle) error

Remove removes the blob with the given name and type.

func (*Backend) Save

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

Save stores data in the backend at the handle.

func (*Backend) Stat

func (b *Backend) Stat(ctx context.Context, h restic.Handle) (restic.FileInfo, error)

Stat returns information about a blob.

func (*Backend) Test

func (b *Backend) Test(ctx context.Context, h restic.Handle) (bool, error)

Test returns true if a blob of the given type and name exists in the backend.

type Config

type Config struct {
	URL         *url.URL
	Connections uint `option:"connections" help:"set a limit for the number of concurrent connections (default: 5)"`
}

Config contains all configuration necessary to connect to a REST server.

func NewConfig

func NewConfig() Config

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

type ErrIsNotExist

type ErrIsNotExist struct {
	restic.Handle
}

ErrIsNotExist is returned whenever the requested file does not exist on the server.

func (ErrIsNotExist) Error

func (e ErrIsNotExist) Error() string