segmented

Documentation

Index

• Constants
• Variables
• type DataReader
  • func NewDataReader(r io.Reader) (*DataReader, error)
  • func (reader *DataReader) Read(p []byte) (n int, err error)
• type DataWriter
  • func NewDataWriter(w io.Writer) *DataWriter
  • func (writer *DataWriter) BytesCompressed() int64
  • func (writer *DataWriter) Close() error
  • func (writer *DataWriter) Write(p []byte) (n int, err error)

Constants

const (
	DefaultCompressionLevel = zlib.BestCompression
)

Variables

var (
	Signature = append([]byte("sd0"), []byte{0x01, 0xff}...)
	ChunkSize = 0x40000
)

Types

type DataReader

type DataReader struct {
	// contains filtered or unexported fields
}

func NewDataReader

func NewDataReader(r io.Reader) (*DataReader, error)

Creates a new sd0 decompressor. NewDataReader returns a nil *DataReader if the function fails to verify the signature.

func (*DataReader) Read

func (reader *DataReader) Read(p []byte) (n int, err error)

type DataWriter

type DataWriter struct {
	// contains filtered or unexported fields
}

NOTE: The live game used Python's zlib library to create sd0 files. Due to zlib implementation differences, DataWriter is NOT guaranteed to produce equivalent sd0 files as generated by lib_segmented.py within the original patcher.

This is only an issue for compressing, not decompressing.

func NewDataWriter

func NewDataWriter(w io.Writer) *DataWriter

Creates a new sd0 compressor.

func (*DataWriter) BytesCompressed

func (writer *DataWriter) BytesCompressed() int64

func (*DataWriter) Close

func (writer *DataWriter) Close() error

func (*DataWriter) Write

func (writer *DataWriter) Write(p []byte) (n int, err error)