gzip

package

v0.15.0 Latest Latest Go to latest Published: Aug 18, 2025 License: BSD-3-Clause Imports: 10 Imported by: 38

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/u-root/u-root

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Compress(r io.Reader, w io.Writer, level int, blocksize int, processes int) error
func Decompress(r io.Reader, w io.Writer, blocksize int, processes int) error
type File
type Options
- func (o *Options) ParseArgs(args []string, cmdLine *flag.FlagSet) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrStdoutNoForce = errors.New("ignoring stdout, use -f to compression")
	ErrHelp          = errors.New("help requested")
)

Functions ¶

func Compress ¶

func Compress(r io.Reader, w io.Writer, level int, blocksize int, processes int) error

Compression and Decompression functions used by the File.Process method. Bare metal support can be enabled, for example, witht the `tinygo` build tag. Setting these build tags will result in the use of pure go libraries for compression/decompression.

func Decompress ¶

func Decompress(r io.Reader, w io.Writer, blocksize int, processes int) error

Decompress takes gzip compressed input from io.Reader and expands it using pgzip or gzip, depending on the build tags. When the `tinygo` build tag is set, the `compress/gzip` package is used and the `processes` argument is ignored.

Types ¶

type File ¶

type File struct {
	Options *Options
	Path    string
}

File is a file path to be compressed or decompressed.

func (*File) CheckOutputPath ¶

func (f *File) CheckOutputPath() error

CheckOutputPath checks if output is attempting to write binary to stdout if stdout is a device. Also checks if output path already exists. Allow override via force option.

func (*File) CheckOutputStdout ¶

func (f *File) CheckOutputStdout() error

CheckOutputStdout checks if output is attempting to write binary to stdout if stdout is a device.

func (*File) CheckPath ¶

func (f *File) CheckPath() error

CheckPath validates the input file path. Checks on compression if the path has the correct suffix, and on decompression checks that it doesn't have the suffix. Allows override by force option. Skip if the input is a Stdin.

func (*File) Cleanup ¶

func (f *File) Cleanup() error

Cleanup removes input file. Overrided with keep option. Skipped if stdout or test option is true.

func (*File) Process ¶

func (f *File) Process() error

Process either compresses or decompressed the input file based on the associated file.options.

type Options ¶

type Options struct {
	Suffix     string
	Blocksize  int
	Level      int
	Processes  int
	Keep       bool
	Help       bool
	Force      bool
	Quiet      bool
	Stdin      bool
	Stdout     bool
	Test       bool
	Verbose    bool
	Decompress bool
}

Options represents the CLI options possible, controlling how gzip operates on the given input data.

func (*Options) ParseArgs ¶

func (o *Options) ParseArgs(args []string, cmdLine *flag.FlagSet) error

ParseArgs takes CLI args and parses them via a Flagset into fields in the Options struct. Returns any errors from parsing and validating options.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL