reader

Documentation

Index

• type CacheOption
  • func WithCacheOpts(cacheOpts ...cache.Option) CacheOption
  • func WithFilter(filter func(*estargz.TOCEntry) bool) CacheOption
  • func WithReader(sr *io.SectionReader) CacheOption
• type Reader
• type VerifiableReader
  • func NewReader(sr *io.SectionReader, cache cache.BlobCache) (*VerifiableReader, *estargz.TOCEntry, error)
  • func (vr *VerifiableReader) SkipVerify() Reader
  • func (vr *VerifiableReader) VerifyTOC(tocDigest digest.Digest) (Reader, error)

Types

type CacheOption

type CacheOption func(*cacheOptions)

func WithCacheOpts

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

func WithFilter

func WithFilter(filter func(*estargz.TOCEntry) bool) CacheOption

func WithReader

func WithReader(sr *io.SectionReader) CacheOption

type Reader

type Reader interface {
	OpenFile(name string) (io.ReaderAt, error)
	Lookup(name string) (*estargz.TOCEntry, bool)
	Cache(opts ...CacheOption) error
}

type VerifiableReader

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

VerifiableReader produces a Reader with a given verifier.

func NewReader

func NewReader(sr *io.SectionReader, cache cache.BlobCache) (*VerifiableReader, *estargz.TOCEntry, error)

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

func (*VerifiableReader) SkipVerify

func (vr *VerifiableReader) SkipVerify() Reader

func (*VerifiableReader) VerifyTOC

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