Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

trix

package

Go to main page

Versions in this module

v0

v0.2.0

Aug 1, 2026

Changes in this version

+ const PrefixSize

+ var ErrNilReader = fmt.Errorf("trix: reader cannot be nil")

+ var ErrNilWriter = fmt.Errorf("trix: writer cannot be nil")

+ func DecodeHeader(r io.Reader, magicNumber string) (map[string]interface{}, io.Reader, error)

+ func DecodeStream(r io.Reader, magicNumber string, payload io.Writer) (map[string]interface{}, int64, error)

+ func EncodeStream(header map[string]interface{}, magicNumber string, payload io.Reader, ...) (int64, error)

+ type HeaderInfo struct

+ Header map[string]interface{}

+ PayloadBytes int64

+ PayloadOffset int64

+ func ReadHeaderInfo(r io.ReaderAt, magicNumber string) (HeaderInfo, error)

v0.1.0

Jul 24, 2026

v0.0.4

Jul 24, 2026

v0.0.2

Dec 25, 2025

Changes in this version

+ const AlgorithmChaCha20Poly1305

+ const HeaderKeyAlgorithm

+ const HeaderKeyEncrypted

+ const HeaderKeyEncryptedAt

+ const HeaderKeyObfuscator

+ const ObfuscatorShuffleMask

+ const ObfuscatorXOR

+ var ErrAlreadyEncrypted = errors.New("trix: payload is already encrypted")

+ var ErrNoEncryptionKey = errors.New("trix: encryption key not configured")

+ var ErrNotEncrypted = errors.New("trix: payload is not encrypted")

+ type CryptoConfig struct

+ Key []byte

+ Obfuscator string

type Trix

+ func NewEncryptedTrix(payload []byte, key []byte, header map[string]interface{}) (*Trix, error)

+ func (t *Trix) DecryptPayload(config *CryptoConfig) error

+ func (t *Trix) EncryptPayload(config *CryptoConfig) error

+ func (t *Trix) GetEncryptionAlgorithm() string

+ func (t *Trix) IsEncrypted() bool

v0.0.1

Nov 14, 2025

Changes in this version

+ const MaxHeaderSize

+ const Version

+ var ErrChecksumMismatch = errors.New("trix: checksum mismatch")

+ var ErrHeaderTooLarge = errors.New("trix: header size exceeds maximum allowed")

+ var ErrInvalidMagicNumber = errors.New("trix: invalid magic number")

+ var ErrInvalidVersion = errors.New("trix: invalid version")

+ var ErrMagicNumberLength = errors.New("trix: magic number must be 4 bytes long")

+ var ErrNilSigil = errors.New("trix: sigil cannot be nil")

+ func Encode(trix *Trix, magicNumber string, w io.Writer) ([]byte, error)

+ type Trix struct

+ ChecksumAlgo crypt.HashType

+ Header map[string]interface{}

+ InSigils []string

+ OutSigils []string

+ Payload []byte

+ func Decode(data []byte, magicNumber string, r io.Reader) (*Trix, error)

+ func (t *Trix) Pack() error

+ func (t *Trix) Unpack() error