...

Package dict

import "github.com/klauspost/compress/dict"
Overview
Index
Subdirectories

Overview ▾

func BuildRawDict

func BuildRawDict(input [][]byte, o Options) ([]byte, error)

BuildRawDict will build a raw dictionary from the provided input. This can be used for deflate, lz4 and others.

func BuildS2Dict

func BuildS2Dict(input [][]byte, o Options) ([]byte, error)

BuildS2Dict will build a S2 dictionary from the provided input.

func BuildZstdDict

func BuildZstdDict(input [][]byte, o Options) ([]byte, error)

BuildZstdDict will build a Zstandard dictionary from the provided input.

type Options

type Options struct {
    // MaxDictSize is the max size of the backreference dictionary.
    MaxDictSize int

    // HashBytes is the minimum length to index.
    // Must be >=4 and <=8
    HashBytes int

    // Debug output
    Output io.Writer

    // ZstdDictID is the Zstd dictionary ID to use.
    // Leave at zero to generate a random ID.
    ZstdDictID uint32

    // ZstdDictCompat will make the dictionary compatible with Zstd v1.5.5 and earlier.
    // See https://github.com/facebook/zstd/issues/3724
    ZstdDictCompat bool

    // Use the specified encoder level for Zstandard dictionaries.
    // The dictionary will be built using the specified encoder level,
    // which will reflect speed and make the dictionary tailored for that level.
    // If not set zstd.SpeedBestCompression will be used.
    ZstdLevel zstd.EncoderLevel
    // contains filtered or unexported fields
}

Subdirectories

Name Synopsis
..
cmd
builddict