cache

Documentation

Index

• type File
  • func Create(path string, h hash.Hash, rsum, dsum []byte) (*File, error)
  • func CreateLevel(path string, h hash.Hash, rsum, dsum []byte, level int) (*File, error)
  • func Open(path string, h hash.Hash, rsum, dsum []byte) (*File, error)
  • func (f *File) Close() error
  • func (f *File) Name() string
  • func (f *File) Read(p []byte) (int, error)
  • func (f *File) ReadOnly() bool
  • func (f *File) Write(p []byte) (int, error)
• type Header
  • func ReadHeader(r io.Reader, size int) (Header, error)
  • func (h Header) Validate(rsum, dsum, bsum []byte) error
  • func (h Header) WriteTo(w io.Writer) (int64, error)

Types

type File

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

File represents a cache file.

func Create

func Create(path string, h hash.Hash, rsum, dsum []byte) (*File, error)

Create a new cache file with the default compression level.

func CreateLevel

func CreateLevel(path string, h hash.Hash, rsum, dsum []byte, level int) (*File, error)

CreateLevel creates a new cache file with the given compression level.

func Open

func Open(path string, h hash.Hash, rsum, dsum []byte) (*File, error)

Open a cache file for reading.

func (*File) Close

func (f *File) Close() error

Close the files and write the body hash sum to the header.

func (*File) Name

func (f *File) Name() string

Name returns the name of the file.

func (*File) Read

func (f *File) Read(p []byte) (int, error)

Read from the file through the flate.Reader.

func (*File) ReadOnly

func (f *File) ReadOnly() bool

ReadOnly returns true if the file is read only.

func (*File) Write

func (f *File) Write(p []byte) (int, error)

Write to the file through the flate.Writer.

type Header

type Header struct {
	RootSum []byte
	DataSum []byte
	BodySum []byte
}

Header represents a cache header.

func ReadHeader

func ReadHeader(r io.Reader, size int) (Header, error)

ReadHeader reads a header with the given hash from the reader.

func (Header) Validate

func (h Header) Validate(rsum, dsum, bsum []byte) error

Validate checks for the hash value integrity.

func (Header) WriteTo

func (h Header) WriteTo(w io.Writer) (int64, error)

WriteTo writes the hash values to the given io.Writer.