pbo

package module

Go to main page

Versions in this module

v0

v0.3.0

Jul 1, 2026

Changes in this version

+ const LargeWriteBuffer

type Reader

+ func (r *Reader) CopyEntryInfoTo(info EntryInfo, dst io.Writer, buf []byte) (int64, error)

+ func (r *Reader) CopyEntryTo(name string, dst io.Writer, buf []byte) (int64, error)

+ func (r *Reader) CopyPackedEntryInfoTo(info EntryInfo, dst io.Writer) (int64, error)

+ func (r *Reader) EntriesView() []EntryInfo

+ func (r *Reader) OpenPackedEntryInfo(info EntryInfo) (io.ReadCloser, error)

+ func (r *Reader) RangeEntries(fn func(EntryInfo) bool)

v0.2.0

Apr 3, 2026

Changes in this version

+ const FileExtension

+ var ErrWriterAtRequired = errors.New("writerAt is required")

+ func ToggleSealedInPlace(out io.ReadWriteSeeker, sealedKeyValue *SealedKey) error

type ExtractOptions

+ ContinueOnError bool

type HeaderPair

+ func ReadHeadersFromReaderAtWithOptions(ra io.ReaderAt, size int64, opts ReaderOptions) ([]HeaderPair, error)

+ func ReadHeadersWithOptions(path string, opts ReaderOptions) ([]HeaderPair, error)

type PackOptions

+ SealedKey *SealedKey

type ReaderOptions

+ SealedKey *SealedKey

+ type SealedKey [16]byte

v0.1.1

Feb 25, 2026

Changes in this version

+ func SanitizePath(pathValue string) (string, error)

type ReaderOptions

+ EntryPathPrefix string

+ FilterASCIIOnly bool

+ MinEntryDataSize uint32

+ MinEntryOriginalSize uint32

+ SanitizeControlChars bool

v0.1.0

Feb 21, 2026

Changes in this version

+ const DefaultMaxCompressSize

+ const DefaultMinCompressSize

+ const DefaultWriteBuffer

+ var ErrClosed = errors.New("reader or resource already closed")

+ var ErrDuplicateEntryPath = errors.New("duplicate entry path")

+ var ErrEmptyInputs = errors.New("no inputs provided for pack")

+ var ErrEntryNotFound = errors.New("entry not found")

+ var ErrExtractPathOutsideRoot = errors.New("extract path escapes destination root")

+ var ErrFileNameTooLong = errors.New("entry filename exceeds maximum length")

+ var ErrInvalidCompressPattern = errors.New("invalid compress rules")

+ var ErrInvalidEntryOffset = errors.New("invalid entry offset")

+ var ErrInvalidEntryPath = errors.New("invalid entry path")

+ var ErrInvalidExtractPath = errors.New("invalid extract path")

+ var ErrInvalidHeader = errors.New("invalid PBO file: missing or bad header")

+ var ErrInvalidSHA1DigestLength = errors.New("invalid SHA1 digest length")

+ var ErrInvalidTrailerPrefix = errors.New("trailer does not start with 0x00")

+ var ErrNilReader = errors.New("reader is nil")

+ var ErrNilWriter = errors.New("writer is nil")

+ var ErrReaderAtRequired = errors.New("readerAt is required")

+ var ErrSizeOverflow = errors.New("size exceeds uint32 or 4 GiB PBO limit")

+ var ErrTrailerHashMismatch = errors.New("trailer hash mismatch")

+ var ErrTrailerTooShort = errors.New("file too short for trailer")

+ var ErrUnsupportedGameTypeV3 = errors.New("unsupported game type for v3")

+ var ErrUnsupportedSignVersion = errors.New("unsupported signature version")

+ func NormalizePath(raw string) string

+ func NormalizePrefixHeader(raw string) string

+ func PackAndHash(ctx context.Context, out io.WriteSeeker, inputs []Input, opts PackOptions, ...) (*PackResult, HashSet, error)

+ func PackAndHashFile(ctx context.Context, outPath string, inputs []Input, opts PackOptions, ...) (*PackResult, HashSet, error)

+ type EditOptions struct

+ BackupKeep int

+ PackOptions PackOptions

+ type Editor struct

+ func OpenEditor(path string, opts EditOptions) (*Editor, error)

+ func (e *Editor) Add(inputs ...Input) error

+ func (e *Editor) Commit(ctx context.Context) (*PackResult, error)

+ func (e *Editor) Delete(paths ...string) error

+ func (e *Editor) DeleteDir(prefixes ...string) error

+ func (e *Editor) Replace(inputs ...Input) error

+ type EntryInfo struct

+ DataSize uint32

+ MimeType MimeType

+ Offset uint32

+ OriginalSize uint32

+ Path string

+ TimeStamp uint32

+ func ListEntries(path string) ([]EntryInfo, error)

+ func ListEntriesFromReaderAt(ra io.ReaderAt, size int64) ([]EntryInfo, error)

+ func ListEntriesFromReaderAtWithOptions(ra io.ReaderAt, size int64, opts ReaderOptions) ([]EntryInfo, error)

+ func ListEntriesWithOptions(path string, opts ReaderOptions) ([]EntryInfo, error)

+ func (e *EntryInfo) IsCompressed() bool

+ type ExtractFileMode string

+ const ExtractFileModeAuto

+ const ExtractFileModeCreateOnly

+ const ExtractFileModeOverwriteSmart

+ const ExtractFileModeTruncate

+ type ExtractOptions struct

+ Entries []EntryInfo

+ FileMode ExtractFileMode

+ MaxWorkers int

+ OnEntryDone func(entry EntryInfo, written int64, outputPath string)

+ RawNames bool

+ type GameType string

+ const GameTypeAny

+ const GameTypeArma

+ const GameTypeDayZ

+ type HashSet struct

+ Hash1 [20]byte

+ Hash2 [20]byte

+ Hash3 [20]byte

+ func ComputeHashSet(path string, version SignVersion, gameType GameType) (HashSet, error)

+ type HeaderPair struct

+ Key string

+ Value string

+ func ReadHeaders(path string) ([]HeaderPair, error)

+ func ReadHeadersFromReaderAt(ra io.ReaderAt, size int64) ([]HeaderPair, error)

+ type Input struct

+ ModTime time.Time

+ Open func() (io.ReadCloser, error)

+ Path string

+ SizeHint int64

+ type MimeType uint32

+ const MimeCompress

+ const MimeEncoded

+ const MimeHeader

+ const MimeNil

+ type OffsetMode string

+ const OffsetModeSequential

+ const OffsetModeStoredCompat

+ const OffsetModeStoredStrict

+ type PackEntryProgress struct

+ Compressed bool

+ CompressionCandidate bool

+ DataSize uint32

+ MimeType MimeType

+ Offset uint32

+ OriginalSize uint32

+ Path string

+ type PackOptions struct

+ Compress []pathrules.Rule

+ CompressMatcherOptions pathrules.MatcherOptions

+ Headers []HeaderPair

+ MaxCompressSize uint32

+ MinCompressSize uint32

+ OnEntryDone func(entry PackEntryProgress)

+ WriterBufferSize int

+ type PackResult struct

+ CompressedBytes int64

+ CompressedEntries int

+ DataSize int64

+ Duration time.Duration

+ IndexSize int64

+ RawBytes int64

+ SkippedCompressionEntries int

+ WrittenEntries int

+ func Pack(ctx context.Context, out io.WriteSeeker, inputs []Input, opts PackOptions) (*PackResult, error)

+ func PackFile(ctx context.Context, outPath string, inputs []Input, opts PackOptions) (*PackResult, error)

+ type Reader struct

+ func NewReaderFromReaderAt(ra io.ReaderAt, size int64) (*Reader, error)

+ func NewReaderFromReaderAtWithOptions(ra io.ReaderAt, size int64, opts ReaderOptions) (*Reader, error)

+ func Open(path string) (*Reader, error)

+ func OpenWithOptions(path string, opts ReaderOptions) (*Reader, error)

+ func (r *Reader) Close() error

+ func (r *Reader) Entries() []EntryInfo

+ func (r *Reader) Extract(ctx context.Context, dstDir string, opts ExtractOptions) error

+ func (r *Reader) Headers() []HeaderPair

+ func (r *Reader) OpenEntry(name string) (io.ReadCloser, error)

+ func (r *Reader) OpenEntryInfo(info EntryInfo) (io.ReadCloser, error)

+ func (r *Reader) ReadEntry(name string) ([]byte, error)

+ func (r *Reader) SHA1Trailer() ([20]byte, bool)

+ type ReaderOptions struct

+ EnableJunkFilter bool

+ OffsetMode OffsetMode

+ SanitizeNames bool

+ type SignVersion uint32

+ const SignVersionV2

+ const SignVersionV3

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