uop

Documentation

Index

• Variables
• type CompressionType
• type Entry
• type Entry6D
• type Option
  • func WithExtension(ext string) Option
  • func WithExtra() Option
  • func WithLength(length int) Option
  • func WithStrict() Option
• type Reader
  • func Open(filename string, length int, options ...Option) (*Reader, error)
  • func (r *Reader) Close() error
  • func (r *Reader) Entries() iter.Seq[uint32]
  • func (r *Reader) Entry(key uint32) (Entry, error)

Variables

var (
	ErrInvalidFormat = errors.New("invalid UOP file format")
	ErrInvalidIndex  = errors.New("invalid index")
	ErrReaderClosed  = errors.New("uop reader is closed")
	ErrEntryNotFound = errors.New("entry not found")
	ErrInvalidEntry  = errors.New("invalid entry")
)

Standard UOP format errors

Types

type CompressionType

type CompressionType int16

CompressionType represents the compression method used for a UOP entry

const (
	CompressionNone   CompressionType = 0
	CompressionZlib   CompressionType = 1
	CompressionMythic CompressionType = 2
)

Compression flag constants

type Entry

type Entry = interface {
	io.ReaderAt
	Len() int
	Extra() uint64
}

type Entry6D

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

Entry6D represents an entry in UOP files with 6 components including compression info

type Option

type Option func(*Reader)

Option defines a function that configures a Reader.

func WithExtension

func WithExtension(ext string) Option

WithExtension sets the file extension for the pattern.

func WithExtra

func WithExtra() Option

WithExtra sets a flag to indicate if extra data is present in the entries.

func WithLength

func WithLength(length int) Option

WithLength sets the length of the index.

func WithStrict

func WithStrict() Option

WithStrict sets a flag to indicate if the reader should perform strict entry validation.

type Reader

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

Reader implements the interface for reading UOP files

func Open

func Open(filename string, length int, options ...Option) (*Reader, error)

Open creates a new UOP file reader

func (*Reader) Close

func (r *Reader) Close() error

Close releases resources

func (*Reader) Entries

func (r *Reader) Entries() iter.Seq[uint32]

Entries returns an iterator over available entry indices

func (*Reader) Entry

func (r *Reader) Entry(key uint32) (Entry, error)

Entry returns an entry reader