reader

Documentation

Index

• func TestSuiteReader(t *testing.T, store metadata.Store)
• type CacheOption
  • func WithCacheOpts(cacheOpts ...cache.Option) CacheOption
  • func WithFilter(filter func(int64) bool) CacheOption
  • func WithReader(sr *io.SectionReader) CacheOption
• type Reader
• type VerifiableReader
  • func NewReader(r metadata.Reader, cache cache.BlobCache, layerSha digest.Digest) (*VerifiableReader, error)
  • func (vr *VerifiableReader) Cache(opts ...CacheOption) (err error)
  • func (vr *VerifiableReader) Close() error
  • func (vr *VerifiableReader) Metadata() metadata.Reader
  • func (vr *VerifiableReader) SkipVerify() Reader
  • func (vr *VerifiableReader) VerifyTOC(tocDigest digest.Digest) (Reader, error)

Functions

func TestSuiteReader

func TestSuiteReader(t *testing.T, store metadata.Store)

Types

type CacheOption

type CacheOption func(*cacheOptions)

func WithCacheOpts

func WithCacheOpts(cacheOpts ...cache.Option) CacheOption

func WithFilter

func WithFilter(filter func(int64) bool) CacheOption

func WithReader

func WithReader(sr *io.SectionReader) CacheOption

type Reader

type Reader interface {
	OpenFile(id uint32) (io.ReaderAt, error)
	Metadata() metadata.Reader
	Close() error
	LastOnDemandReadTime() time.Time
}

type VerifiableReader

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

VerifiableReader produces a Reader with a given verifier.

func NewReader

func NewReader(r metadata.Reader, cache cache.BlobCache, layerSha digest.Digest) (*VerifiableReader, error)

NewReader creates a Reader based on the given stargz blob and cache implementation. It returns VerifiableReader so the caller must provide a metadata.ChunkVerifier to use for verifying file or chunk contained in this stargz blob.

func (*VerifiableReader) Cache

func (vr *VerifiableReader) Cache(opts ...CacheOption) (err error)

func (*VerifiableReader) Close

func (vr *VerifiableReader) Close() error

func (*VerifiableReader) Metadata

func (vr *VerifiableReader) Metadata() metadata.Reader

func (*VerifiableReader) SkipVerify

func (vr *VerifiableReader) SkipVerify() Reader

func (*VerifiableReader) VerifyTOC

func (vr *VerifiableReader) VerifyTOC(tocDigest digest.Digest) (Reader, error)