b2

Documentation

Overview

Package b2 provides an interface to the Backblaze B2 object storage system

Index

• func NewFs(name, root string) (fs.Fs, error)
• type Fs
  • func (f *Fs) List() fs.ObjectsChan
  • func (f *Fs) ListDir() fs.DirChan
  • func (f *Fs) Mkdir() error
  • func (f *Fs) Name() string
  • func (f *Fs) NewFsObject(remote string) fs.Object
  • func (f *Fs) Precision() time.Duration
  • func (f *Fs) Purge() error
  • func (f *Fs) Put(in io.Reader, remote string, modTime time.Time, size int64) (fs.Object, error)
  • func (f *Fs) Rmdir() error
  • func (f *Fs) Root() string
  • func (f *Fs) String() string
• type Object
  • func (o *Object) Fs() fs.Fs
  • func (o *Object) Md5sum() (string, error)
  • func (o *Object) ModTime() (result time.Time)
  • func (o *Object) Open() (in io.ReadCloser, err error)
  • func (o *Object) Remote() string
  • func (o *Object) Remove() error
  • func (o *Object) SetModTime(modTime time.Time)
  • func (o *Object) Size() int64
  • func (o *Object) Storable() bool
  • func (o *Object) String() string
  • func (o *Object) Update(in io.Reader, modTime time.Time, size int64) (err error)

Functions

func NewFs

func NewFs(name, root string) (fs.Fs, error)

NewFs contstructs an Fs from the path, bucket:path

Types

type Fs

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

Fs represents a remote b2 server

func (*Fs) List

func (f *Fs) List() fs.ObjectsChan

List walks the path returning a channel of FsObjects

func (*Fs) ListDir

func (f *Fs) ListDir() fs.DirChan

ListDir lists the buckets

func (*Fs) Mkdir

func (f *Fs) Mkdir() error

Mkdir creates the bucket if it doesn't exist

func (*Fs) Name

func (f *Fs) Name() string

Name of the remote (as passed into NewFs)

func (*Fs) NewFsObject

func (f *Fs) NewFsObject(remote string) fs.Object

NewFsObject returns an FsObject from a path

May return nil if an error occurred

func (*Fs) Precision

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

Precision of the remote

func (*Fs) Purge

func (f *Fs) Purge() error

Purge deletes all the files and directories

Implemented here so we can make sure we delete old versions.

func (*Fs) Put

func (f *Fs) Put(in io.Reader, remote string, modTime time.Time, size int64) (fs.Object, error)

Put the object into the bucket

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

func (f *Fs) Rmdir() error

Rmdir deletes the bucket if the fs is at the root

Returns an error if it isn't empty

func (*Fs) Root

func (f *Fs) Root() string

Root of the remote (as passed into NewFs)

func (*Fs) String

func (f *Fs) String() string

String converts this Fs to a string

type Object

type Object struct {
	// contains filtered or unexported fields
}

Object describes a b2 object

Will definitely have info

func (*Object) Fs

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

Fs returns the parent Fs

func (*Object) Md5sum

func (o *Object) Md5sum() (string, error)

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

func (*Object) ModTime

func (o *Object) ModTime() (result 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

func (o *Object) Open() (in io.ReadCloser, err error)

Open an object for read

func (*Object) Remote

func (o *Object) Remote() string

Remote returns the remote path

func (*Object) Remove

func (o *Object) Remove() error

Remove an object

func (*Object) SetModTime

func (o *Object) SetModTime(modTime time.Time)

SetModTime sets the modification time of the local fs object

func (*Object) Size

func (o *Object) Size() int64

Size returns the size of an object in bytes

func (*Object) Storable

func (o *Object) Storable() bool

Storable returns if this object is storable

func (*Object) String

func (o *Object) String() string

Return a string version

func (*Object) Update

func (o *Object) Update(in io.Reader, modTime time.Time, size int64) (err error)

Update the object with the contents of the io.Reader, modTime and size

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