archive

type Archive interface {
	Entries() []Entry                 // List of all the archived file entries.
	Entry(path string) (Entry, error) // Gets the entry at the given `path`.
	Close()
}

type ArchiveFactory interface {
	Open(ctx context.Context, location url.URL, password string) (Archive, error)                                            // Opens an archive from a location.
	OpenBytes(ctx context.Context, data []byte, password string) (Archive, error)                                            // Opens an archive from a [data] slice.
	OpenReader(ctx context.Context, reader ReaderAtCloser, size int64, password string, minimizeReads bool) (Archive, error) // Opens an archive from a reader.
}

type CompressionMethod uint16

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

type Entry interface {
	Path() string                                              // Absolute path to the entry in the archive.
	Length() uint64                                            // Uncompressed data length.
	CompressedLength() uint64                                  // Compressed data length.
	CompressedAs(compressionMethod CompressionMethod) bool     // Whether the entry is compressed using the given method.
	Read(start int64, end int64) ([]byte, error)               // Reads the whole content of this entry, or a portion when [start] or [end] are specified.
	Stream(w io.Writer, start int64, end int64) (int64, error) // Streams the whole content of this entry to a writer, or a portion when [start] or [end] are specified.

	StreamCompressed(w io.Writer) (int64, error)     // Streams the compressed content of this entry to a writer.
	StreamCompressedGzip(w io.Writer) (int64, error) // Streams the compressed content of this entry to a writer in a GZIP container.
	ReadCompressed() ([]byte, error)                 // Reads the compressed content of this entry.
	ReadCompressedGzip() ([]byte, error)             // Reads the compressed content of this entry inside a GZIP container.
}

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

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

type ReaderAtCloser interface {
	io.Closer
	io.ReaderAt
}

type RemoteArchiveConfig struct {
	Timeout             time.Duration // Timeout for remote requests to read from the archive
	CacheAllThreshold   int64         // Threshold for caching the entire ZIP
	CacheSizeThreshold  int64         // Threshold for caching of a single entry in the ZIP
	CacheCountThreshold int64         // Threshold for the number of entries in the ZIP to cache
}

type RemoteArchiveReader interface {
	Size() int64                                                                // Size of the remote archive object
	ReadRange(ctx context.Context, offset, length int64) (io.ReadCloser, error) // Negative length means "read to the end"
}

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

type SchemeSpecificArchiveFactory interface {
	CanOpen(url.Scheme) bool // Whether this factory can open the given scheme.
}