reedsolomon

Aug 12, 2026

Changes in this version

+ var ErrInvShardCombo = errors.New("data and parity shard combination not supported by leopard encoder")

type Option

+ func WithNEON(enabled bool) Option

+ func WithSVE(enabled bool) Option

Apr 22, 2026

Changes in this version

type LowLevel

+ func (l LowLevel) GF16MulSliceXor(scalar uint16, in []byte, out []byte)

+ func (l LowLevel) GF16MulSliceXor8(scalars *[8]uint16, in []byte, outs *[8][]byte)

type Option

+ func WithWorkAllocator(alloc WorkAllocator) Option

+ type WorkAllocator interface

+ Get func(n, size int) [][]byte

+ Put func([][]byte)

Mar 6, 2026

Changes in this version

type LowLevel

+ func (l LowLevel) GF16Mul(a, b uint16) uint16

Jan 9, 2026

Changes in this version

type Extensions

+ DecodeIdx func(dst [][]byte, expectInput []bool, input [][]byte) error

Jul 15, 2025

Changes in this version

+ func Inv(e byte) byte

+ type LowLevel struct

+ func (l *LowLevel) WithOptions(opts ...Option)

+ func (l LowLevel) GalMulSlice(c byte, in, out []byte)

+ func (l LowLevel) GalMulSliceXor(c byte, in, out []byte)

Jan 26, 2024

Changes in this version

type Option

+ func WithAVXGFNI(enabled bool) Option

Jun 26, 2023

Changes in this version

+ var ErrInvalidShardSize = errors.New("invalid shard size")

Jan 16, 2023

retracted

Changes in this version

+ func AllocAligned(shards, each int) [][]byte

type Extensions

+ AllocAligned func(each int) [][]byte

Nov 17, 2022

retracted

Changes in this version

type Option

+ func WithGFNI(enabled bool) Option

Oct 4, 2022

Changes in this version

type Option

+ func WithLeopardGF(enabled bool) Option

Sep 11, 2022

Changes in this version

+ var ErrNotSupported = errors.New("operation not supported")

+ type Extensions interface

+ DataShards func() int

+ ParityShards func() int

+ ShardSizeMultiple func() int

+ TotalShards func() int

type Option

+ func WithJerasureMatrix() Option

+ func WithLeopardGF16(enabled bool) Option

Jun 21, 2022

Changes in this version

type Encoder

+ ReconstructSome func(shards [][]byte, required []bool) error

type Option

+ func WithAVX2(enabled bool) Option

+ func WithAVX512(enabled bool) Option

+ func WithCustomMatrix(customMatrix [][]byte) Option

+ func WithSSE2(enabled bool) Option

+ func WithSSSE3(enabled bool) Option

Oct 26, 2021

Changes in this version

type Encoder

+ EncodeIdx func(dataShard []byte, idx int, parity [][]byte) error

Jan 13, 2021

Changes in this version

type Option

+ func WithInversionCache(enabled bool) Option

May 14, 2020

Changes in this version

type Option

+ func WithFastOneParityMatrix() Option

May 9, 2020

Changes in this version

type Option

+ func WithConcurrentStreamReads(enabled bool) Option

+ func WithConcurrentStreamWrites(enabled bool) Option

+ func WithConcurrentStreams(enabled bool) Option

+ func WithStreamBlockSize(n int) Option

Nov 15, 2018

Changes in this version

+ var ErrInvShardNum = errors.New("cannot create Encoder with zero or less data/parity shards")

+ var ErrInvalidInput = errors.New("invalid input")

+ var ErrMaxShardNum = errors.New("cannot create Encoder with more than 256 data+parity shards")

+ var ErrReconstructMismatch = errors.New("valid shards and fill shards are mutually exclusive")

+ var ErrReconstructRequired = errors.New("reconstruction required as one or more required data shards are nil")

+ var ErrShardNoData = errors.New("no shard data")

+ var ErrShardSize = errors.New("shard sizes do not match")

+ var ErrShortData = errors.New("not enough data to fill the number of requested shards")

+ var ErrTooFewShards = errors.New("too few shards given")

+ type Encoder interface

+ Encode func(shards [][]byte) error

+ Join func(dst io.Writer, shards [][]byte, outSize int) error

+ Reconstruct func(shards [][]byte) error

+ ReconstructData func(shards [][]byte) error

+ Split func(data []byte) ([][]byte, error)

+ Update func(shards [][]byte, newDatashards [][]byte) error

+ Verify func(shards [][]byte) (bool, error)

+ func New(dataShards, parityShards int, opts ...Option) (Encoder, error)

+ type Option func(*options)

+ func WithAutoGoroutines(shardSize int) Option

+ func WithCauchyMatrix() Option

+ func WithMaxGoroutines(n int) Option

+ func WithMinSplitSize(n int) Option

+ func WithPAR1Matrix() Option

+ type StreamEncoder interface

+ Encode func(data []io.Reader, parity []io.Writer) error

+ Join func(dst io.Writer, shards []io.Reader, outSize int64) error

+ Reconstruct func(valid []io.Reader, fill []io.Writer) error

+ Split func(data io.Reader, dst []io.Writer, size int64) (err error)

+ Verify func(shards []io.Reader) (bool, error)

+ func NewStream(dataShards, parityShards int, o ...Option) (StreamEncoder, error)

+ func NewStreamC(dataShards, parityShards int, conReads, conWrites bool, o ...Option) (StreamEncoder, error)

+ type StreamReadError struct

+ Err error

+ Stream int

+ func (s StreamReadError) Error() string

+ func (s StreamReadError) String() string

+ type StreamWriteError struct

+ Err error

+ Stream int

+ func (s StreamWriteError) Error() string

+ func (s StreamWriteError) String() string