gzip

README

gzip

Gzip middleware for Martini.

API Reference

Usage

import (
  "github.com/go-martini/martini"
  "github.com/martini-contrib/gzip"
)

func main() {
  m := martini.Classic()
  // gzip every request
  m.Use(gzip.All())
  m.Run()
}

Make sure to include the Gzip middleware above other middleware that alter the response body (like the render middleware).

Changing compression level

You can set compression level using gzip.Options:

import (
  "github.com/go-martini/martini"
  "github.com/martini-contrib/gzip"
)

func main() {
  m := martini.Classic()
  // gzip every request with maximum compression level
  m.Use(gzip.All(gzip.Options{
    CompressionLevel: gzip.BestCompression,
  }))
  m.Run()
}

The compression level can be DefaultCompression or any integer value between BestSpeed and BestCompression inclusive.

Authors

• Jeremy Saenz
• Shane Logsdon

Documentation

Index

• Constants
• func All(options ...Options) martini.Handler
• type Options

Constants

const (
	HeaderAcceptEncoding  = "Accept-Encoding"
	HeaderContentEncoding = "Content-Encoding"
	HeaderContentLength   = "Content-Length"
	HeaderContentType     = "Content-Type"
	HeaderVary            = "Vary"
	BestSpeed             = gzip.BestSpeed
	BestCompression       = gzip.BestCompression
	DefaultCompression    = gzip.DefaultCompression
)

Functions

func All

func All(options ...Options) martini.Handler

All returns a Handler that adds gzip compression to all requests

Types

type Options

type Options struct {
	// Compression level. Can be DefaultCompression or any integer value between BestSpeed and BestCompression inclusive.
	CompressionLevel int
}

Options is a struct for specifying configuration options.