recordio

package

Go to main page

Versions in this module

v1

v1.6.1

Dec 13, 2024

Changes in this version

+ type FileReaderOption func(*FileReaderOptions)

+ func ReaderBufferSizeBytes(p int) FileReaderOption

+ func ReaderFile(p *os.File) FileReaderOption

+ func ReaderIoFactory(factory IOFactory) FileReaderOption

+ func ReaderPath(p string) FileReaderOption

+ type FileReaderOptions struct

+ type IOFactory interface

+ CreateNewReader func(filePath string, bufSize int) (*os.File, ByteReaderResetCount, error)

+ CreateNewWriter func(filePath string, bufSize int) (*os.File, WriteCloserFlusher, error)

type ReaderI

+ func NewFileReader(readerOptions ...FileReaderOption) (ReaderI, error)

v1.6.0

Nov 7, 2024

Changes in this version

+ const RecordHeaderSizeBytesV1V2

+ const RecordHeaderV3MaxSizeBytes

+ const Version3

+ func SkipNextV2(r *FileReader) error

v1.5.0

Jul 28, 2024

v1.4.0

Dec 2, 2022

Changes in this version

+ const CompressionTypeLzw

+ var DirectIOSyncWriteErr = errors.New("currently not supporting directIO with sync writing")

+ var MagicNumberMismatchErr = fmt.Errorf("magic number mismatch")

+ func IsDirectIOAvailable() (available bool, err error)

+ type BufferedIOFactory struct

+ func (d BufferedIOFactory) CreateNewReader(filePath string, bufSize int) (*os.File, ByteReaderResetCount, error)

+ func (d BufferedIOFactory) CreateNewWriter(filePath string, bufSize int) (*os.File, WriteCloserFlusher, error)

+ type ByteReaderReset interface

+ Size func() int

+ type ByteReaderResetCount interface

+ Count func() uint64

type CountingBufferedReader

+ func (c *CountingBufferedReader) Size() int

+ type DirectIOFactory struct

+ func (d DirectIOFactory) CreateNewReader(filePath string, bufSize int) (*os.File, ByteReaderResetCount, error)

+ func (d DirectIOFactory) CreateNewWriter(filePath string, bufSize int) (*os.File, WriteCloserFlusher, error)

+ type Reader struct

+ func NewReaderBuf(rd io.Reader, buf []byte) *Reader

+ func (b *Reader) Buffered() int

+ func (b *Reader) Read(p []byte) (n int, err error)

+ func (b *Reader) ReadByte() (byte, error)

+ func (b *Reader) Reset(r io.Reader)

+ func (b *Reader) Size() int

+ type ReaderWriterCloserFactory interface

+ CreateNewReader func(filePath string, bufSize int) (*os.File, ByteReaderResetCount, error)

+ CreateNewWriter func(filePath string, bufSize int) (*os.File, WriteCloserFlusher, error)

+ type WriteCloserFlusher interface

+ Flush func() error

+ Size func() int

+ func NewAlignedWriterBuf(w io.WriteCloser, buf []byte) WriteCloserFlusher

+ func NewWriterBuf(w io.WriteCloser, buf []byte) WriteCloserFlusher

+ type Writer struct

+ func (b *Writer) Available() int

+ func (b *Writer) Close() error

+ func (b *Writer) Flush() error

+ func (b *Writer) Size() int

+ func (b *Writer) Write(p []byte) (nn int, err error)

v1.3.1

Sep 15, 2021

v1.3.0

Aug 27, 2021

Changes in this version

+ const DefaultBufferSize

type CountingBufferedReader

+ func (c *CountingBufferedReader) Count() uint64

type CountingReaderResetComposite

+ Count func() uint64

type FileWriterOption

+ func BufferSizeBytes(p int) FileWriterOption

+ func DirectIO() FileWriterOption

+ type ReaderResetComposite interface

v1.2.0

Jun 6, 2021

Changes in this version

type FileWriter

+ func NewFileWriter(writerOptions ...FileWriterOption) (*FileWriter, error)

+ type FileWriterOption func(*FileWriterOptions)

+ func CompressionType(p int) FileWriterOption

+ func File(p *os.File) FileWriterOption

+ func Path(p string) FileWriterOption

+ type FileWriterOptions struct

v1.1.0

Oct 24, 2020

Changes in this version

+ const CurrentVersion

+ const MagicNumberSeparatorLong

+ const RecordHeaderV2MaxSizeBytes

+ const Version1

+ const Version2

+ func SkipNextV1(r *FileReader) error

+ type CloseableI interface

+ Close func() error

+ type CountingBufferedReader struct

+ func NewCountingByteReader(reader *bufio.Reader) *CountingBufferedReader

+ func (c *CountingBufferedReader) Read(p []byte) (n int, err error)

+ func (c *CountingBufferedReader) ReadByte() (byte, error)

+ func (c *CountingBufferedReader) Reset(r io.Reader)

+ type CountingReaderResetComposite interface

type FileWriter

+ func (w *FileWriter) Size() uint64

+ type OpenableI interface

+ Open func() error

type ProtoWriter

+ func (w *ProtoWriter) Size() uint64

+ type Reset interface

+ Reset func(r io.Reader)

+ type SizeI interface

+ Size func() uint64

v1.0.0

Jan 12, 2019

Changes in this version

+ const CompressionTypeGZIP

+ const CompressionTypeNone

+ const CompressionTypeSnappy

+ const FileHeaderSizeBytes

+ const MagicNumberSeparator

+ const RecordHeaderSizeBytes

+ const Version

+ func NewCompressorForType(compType int) (compressor.CompressionI, error)

+ type FileReader struct

+ func NewFileReaderWithFile(file *os.File) (*FileReader, error)

+ func NewFileReaderWithPath(path string) (*FileReader, error)

+ func (r *FileReader) Close() error

+ func (r *FileReader) Open() error

+ func (r *FileReader) ReadNext() ([]byte, error)

+ func (r *FileReader) SkipNext() error

+ type FileWriter struct

+ func NewCompressedFileWriterWithFile(file *os.File, compType int) (*FileWriter, error)

+ func NewCompressedFileWriterWithPath(path string, compType int) (*FileWriter, error)

+ func NewFileWriterWithFile(file *os.File) (*FileWriter, error)

+ func NewFileWriterWithPath(path string) (*FileWriter, error)

+ func (w *FileWriter) Close() error

+ func (w *FileWriter) Open() error

+ func (w *FileWriter) Write(record []byte) (uint64, error)

+ func (w *FileWriter) WriteSync(record []byte) (uint64, error)

+ type Header struct

+ type MMapProtoReader struct

+ func NewMMapProtoReaderWithPath(path string) (*MMapProtoReader, error)

+ func (r *MMapProtoReader) Close() error

+ func (r *MMapProtoReader) Open() error

+ func (r *MMapProtoReader) ReadNextAt(record proto.Message, offset uint64) (proto.Message, error)

+ type MMapReader struct

+ func NewMemoryMappedReaderWithPath(path string) (*MMapReader, error)

+ func (r *MMapReader) Close() error

+ func (r *MMapReader) Open() error

+ func (r *MMapReader) ReadNextAt(offset uint64) ([]byte, error)

+ type OpenClosableI interface

+ Close func() error

+ Open func() error

+ type ProtoReadAtI interface

+ ReadNextAt func(record proto.Message, offset uint64) (proto.Message, error)

+ type ProtoReader struct

+ func NewProtoReaderWithFile(file *os.File) (*ProtoReader, error)

+ func NewProtoReaderWithPath(path string) (*ProtoReader, error)

+ func (r *ProtoReader) Close() error

+ func (r *ProtoReader) Open() error

+ func (r *ProtoReader) ReadNext(record proto.Message) (proto.Message, error)

+ func (r *ProtoReader) SkipNext() error

+ type ProtoReaderI interface

+ ReadNext func(record proto.Message) (proto.Message, error)

+ SkipNext func() error

+ type ProtoWriter struct

+ func NewCompressedProtoWriterWithFile(file *os.File, compType int) (*ProtoWriter, error)

+ func NewCompressedProtoWriterWithPath(path string, compType int) (*ProtoWriter, error)

+ func NewProtoWriterWithFile(file *os.File) (*ProtoWriter, error)

+ func NewProtoWriterWithPath(path string) (*ProtoWriter, error)

+ func (w *ProtoWriter) Close() error

+ func (w *ProtoWriter) Open() error

+ func (w *ProtoWriter) Write(record proto.Message) (uint64, error)

+ func (w *ProtoWriter) WriteSync(record proto.Message) (uint64, error)

+ type ProtoWriterI interface

+ Write func(record proto.Message) (uint64, error)

+ WriteSync func(record proto.Message) (uint64, error)

+ type ReadAtI interface

+ ReadNextAt func(offset uint64) ([]byte, error)

+ type ReaderI interface

+ ReadNext func() ([]byte, error)

+ SkipNext func() error

+ type WriterI interface

+ Write func(record []byte) (uint64, error)

+ WriteSync func(record []byte) (uint64, error)

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