README
¶
Go yEncode (yenc) decoder module
A Go port of the decoder functionality of yencode 0.46 that decodes binary data for Usenet (NNTP) transfer.
Forked from https://github.com/go-yenc/yenc and enhanced with more robust parsing and error handling. Encoding features ommitted from this fork.
📚 Guides & Documentation
Example use
go get github.com/ovrlord-app/go-yenc-decoder
package main
import (
"fmt"
"io"
"os"
yenc "github.com/ovrlord-app/go-yenc-decoder"
)
func decodePart(articleBody []byte, outFile *os.File) (int64, error) {
decoder, err := yenc.Decode(articleBody, yenc.DecodeWithPrefixData())
if err != nil {
return 0, fmt.Errorf("yenc: %w", err)
}
written, err := io.Copy(outFile, decoder)
if err != nil {
return written, err
}
return written, nil
}
License
This project is licensed under the MIT - see the LICENSE file for details.
Support
- 🐛 Issues
Documentation
¶
Overview ¶
Copied from https://github.com/go-yenc/yenc and enhanced with more robust parsing and error handling. The original license is MIT.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var BufferLimit = 256 * 1024
Max number of bytes per line (ends in LF and includes the LF) when decoding yEnc data stream. Set to 256 KiB so the ring buffer can hold many complete yEnc lines, avoiding boundary issues that caused stalling with the original 4 KiB default.
var ErrBufferTooSmall = errors.New("buffer too small")
var ErrDataCorruption = errors.New("data corruption detected")
var ErrInvalidFormat = errors.New("not a valid yEncode formatted data stream")
var ErrRejectPrefixData = errors.New("yEncode not started at the beginning of the data stream")
var LineLimit uint64 = 128
Max number of bytes per line (ends in LF but NOT include the LF) when encoding yEnc data stream. Default is 128 which is a commonly acceptable limit for probably all known NNTP and yEncode implementations.
Functions ¶
func ApplyOption ¶
func ApplyOption[T any, O ~func(*T)](opts *T, options []O, defaults ...O) *T
Types ¶
type DecodeOption ¶
type DecodeOption func(*Decoder)
func DecodeWithBuffer ¶
func DecodeWithBuffer(b []byte) DecodeOption
func DecodeWithBufferSize ¶
func DecodeWithBufferSize(size int) DecodeOption
func DecodeWithPrefixData ¶
func DecodeWithPrefixData() DecodeOption
type Decoder ¶
type Decoder struct {
// contains filtered or unexported fields
}
type Header ¶
type Header struct {
Name string // Name of the final output file
Size uint64 // Final, overall file size (of all parts decoded)
Part uint64 // Part number (starts from 1)
Total uint64 // Total number of parts. Optional even for multipart.
Line uint64 // Average line length
Begin uint64 // Part begin offset (0-indexed). Note the begin keyword in the =ypart line is 1-indexed.
End uint64 // Part end offset (0-indexed, exclusive)
}
yEncode header information
Source Files