ea

package

v0.0.21 Latest Latest Go to latest Published: Aug 21, 2026 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/stergiotis/boxer

Links

Documentation ¶

Index ¶

Variables
type BaseReader
- func NewBaseReader(r io.Reader, nAnchorBytes uint8, maxHammingDistPerByteIncl uint8, ...) *BaseReader
type MessageReaderI
type MessageWriterI

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrTooFar = eh.Errorf("unable to peek byte, peeked more bytes than maxMessageSize")

View Source

var PackageProps = packageprops.Props{
	WASMWASI:         packageprops.WASMCompiles,
	WASMJS:           packageprops.WASMCompiles,
	WASMFreestanding: packageprops.WASMCompiles,
}

PackageProps records this package's curated properties (ADR-0080). Seeded by `boxer code analysis golang wasmsurvey props generate`; curate by hand. The same group's `props verify` reconciles it.

Functions ¶

This section is empty.

Types ¶

type BaseReader ¶

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

func NewBaseReader ¶

func NewBaseReader(r io.Reader, nAnchorBytes uint8, maxHammingDistPerByteIncl uint8, maxMessageSize uint32) *BaseReader

func (*BaseReader) Bytes ¶

func (inst *BaseReader) Bytes() (r []byte, err error)

func (*BaseReader) BytesPeeked ¶

func (inst *BaseReader) BytesPeeked() int

BytesPeeked returns how many bytes have been peeked from the underlying reader (in-message).

func (*BaseReader) BytesRead ¶

func (inst *BaseReader) BytesRead() int

BytesRead returns how many bytes have been consumed from the underlying reader.

func (*BaseReader) DetectedBitErrors ¶

func (inst *BaseReader) DetectedBitErrors() int

func (*BaseReader) DiscardPeeking ¶

func (inst *BaseReader) DiscardPeeking(nBytes int) (n int, err error)

func (*BaseReader) EnsureSkippedPastAnchor ¶

func (inst *BaseReader) EnsureSkippedPastAnchor() (err error)

func (*BaseReader) InMessage ¶

func (inst *BaseReader) InMessage() bool

func (*BaseReader) MessageAccepted ¶

func (inst *BaseReader) MessageAccepted() (err error)

func (*BaseReader) MessageRejected ¶

func (inst *BaseReader) MessageRejected(reason error) (err error)

func (*BaseReader) PeekByte ¶

func (inst *BaseReader) PeekByte() (b byte, err error)

type MessageReaderI ¶

type MessageReaderI interface {
	ea.ByteBlockDiscardReaderI
	// BytesRead return how many bytes have been consumed from the underlying reader
	BytesRead() int
	// BytesPeeked return how many bytes have been peeked from the underlying reader (in-message)
	BytesPeeked() int
	Discard(nBytes int) (n int, err error)
	MessageAccepted() (err error)
	MessageRejected(reason error) (err error)
	DetectedBitErrors() int
}

type MessageWriterI ¶

type MessageWriterI interface {
	io.ByteWriter
	io.Writer
	BeginMessage() (n int, err error)
	EndMessage() (paddingBitsBeforeEncoding int, err error)
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
config
golay24
passthrough

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