detectreader

README

Detect Reader

Detect reader reads the first bytes looking for magic bytes. Then it returns an appropriate reader for that stream.

Installation

Windows, OS X & Linux:

go get github.com/gurre/detectreader

Usage examples

Simple usage:

// Some compressed byte stream
reader := bytes.NewReader(b)
// The returned reader is a decompressor
decompressedReader, err := Decompress(reader)

Documentation

Index

• func Decompress(stream io.Reader) (io.Reader, error)
• type Compression
  • func DetectCompression(source []byte) Compression
  • func (compression *Compression) Extension() string

Functions

func Decompress

func Decompress(stream io.Reader) (io.Reader, error)

Decompress takes a reader, detects magic bytes and returns another reader for that compression

Types

type Compression

type Compression int

Compression represents the supported compress readers

const (
	// Uncompressed is the same reader you passed in
	Uncompressed Compression = iota
	// Bzip2 is a reader
	Bzip2
	// Gzip is a reader
	Gzip
	// Xz is a reader
	Xz
)

func DetectCompression

func DetectCompression(source []byte) Compression

DetectCompression compares for any magic bytes

func (*Compression) Extension

func (compression *Compression) Extension() string

Extension returns the file extension for the detected type