file

Documentation

Index

• Constants
• Variables
• func FileSize(filePath string) (int64, error)
• func PackFiles(files []*os.File) (*os.File, int64, error)
• func ReadFiles(fileNames []string) ([]*os.File, error)
• func RemoveTemporaryFiles(prefix string)
• type Committer
• type Unpacker
  • func NewUnpacker(prompt bool, r io.ReadCloser) (*Unpacker, error)
  • func (u *Unpacker) Close() error
  • func (u *Unpacker) Unpack() (Committer, error)

Constants

const RECEIVE_TEMP_FILE_NAME_PREFIX = "portal-receive-temp"

const SEND_TEMP_FILE_NAME_PREFIX = "portal-send-temp"

Variables

var ErrUninitialized = errors.New("unpacker is uninitialized")

var ErrUnpackFileExists = errors.New("file exists")

var ErrUnpackNoHeader = errors.New("no header in tar archive")

Functions

func FileSize

func FileSize(filePath string) (int64, error)

Traverses a file or directory recursively for total size in bytes.

func PackFiles

func PackFiles(files []*os.File) (*os.File, int64, error)

PackFiles tars and gzip-compresses files into a temporary file, returning it along with the resulting size

func ReadFiles

func ReadFiles(fileNames []string) ([]*os.File, error)

func RemoveTemporaryFiles

func RemoveTemporaryFiles(prefix string)

optimistically remove files created by portal with the specified prefix

Types

type Committer

type Committer interface {
	FileName() string
	Commit() (int64, error)
}

Committer defines a unit that can commit a file to disk

type Unpacker

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

Unpacker defines an encapsulated unit for unpacking a compressed tar archive

func NewUnpacker

func NewUnpacker(prompt bool, r io.ReadCloser) (*Unpacker, error)

func (*Unpacker) Close

func (u *Unpacker) Close() error

Close closes all underlying readers of the unpacker.

func (*Unpacker) Unpack

func (u *Unpacker) Unpack() (Committer, error)

Unpack will decompress and unpack the archive. Resolves a Committer which can be used to write file to disk. If the unpacker is configured to prompt it will return a ErrUnpackFileExists along with the committer. Returns a io.EOF once the archive has been fully consumed.