zipstream

Documentation

Overview

Package zipstream provides streaming helpers to create a zip archive and send it as base64 without buffering the entire archive in memory.

Use StreamZipToBase64 for convenience or StreamZipToBase64Writer to stream directly to an io.Writer with optional context for cancellation.

Index

• func SafeJoin(baseDir, relPath string) (string, error)
• func StreamZipToBase64(entries []Entry, opts *Options) (string, error)
• func StreamZipToBase64Writer(ctx context.Context, w io.Writer, entries []Entry, opts *Options) (err error)
• type Entry
• type Options

Functions

func SafeJoin

func SafeJoin(baseDir, relPath string) (string, error)

SafeJoin joins baseDir and relPath, ensuring result stays within baseDir.

func StreamZipToBase64

func StreamZipToBase64(entries []Entry, opts *Options) (string, error)

func StreamZipToBase64Writer

func StreamZipToBase64Writer(ctx context.Context, w io.Writer, entries []Entry, opts *Options) (err error)

Types

type Entry

type Entry struct {
	Name string
	Path string
}

type Options

type Options struct {
	CompressionLevel int
	SkipMissing      bool
	Filter           func(e Entry) bool
	NowFunc          func() time.Time
	// BaseDir: if set, resolve Entry.Path relative to this directory using SafeJoin.
	BaseDir string
}