proto

Documentation

Index

• type MMapProtoReader
  • func (r *MMapProtoReader) Close() error
  • func (r *MMapProtoReader) Open() error
  • func (r *MMapProtoReader) ReadNextAt(record proto.Message, offset uint64) (proto.Message, error)
• type ReadAtI
  • func NewMMapProtoReaderWithPath(path string) (ReadAtI, error)
• type Reader
  • func (r *Reader) Close() error
  • func (r *Reader) Open() error
  • func (r *Reader) ReadNext(record proto.Message) (proto.Message, error)
  • func (r *Reader) SkipNext() error
• type ReaderI
  • func NewProtoReaderWithFile(file *os.File) (ReaderI, error)
  • func NewProtoReaderWithPath(path string) (ReaderI, error)
• type Writer
  • func (w *Writer) Close() error
  • func (w *Writer) Open() error
  • func (w *Writer) Size() uint64
  • func (w *Writer) Write(record proto.Message) (uint64, error)
  • func (w *Writer) WriteSync(record proto.Message) (uint64, error)
• type WriterI
  • func NewWriter(writerOptions ...WriterOption) (WriterI, error)
• type WriterOption
  • func CompressionType(p int) WriterOption
  • func DirectIO() WriterOption
  • func File(p *os.File) WriterOption
  • func Path(p string) WriterOption
  • func WriteBufferSizeBytes(p int) WriterOption
• type WriterOptions

Types

type MMapProtoReader

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

func (*MMapProtoReader) Close

func (r *MMapProtoReader) Close() error

func (*MMapProtoReader) Open

func (r *MMapProtoReader) Open() error

func (*MMapProtoReader) ReadNextAt

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

type ReadAtI

type ReadAtI interface {
	recordio.OpenClosableI
	// Reads the next record at the given offset into the passed message record, EOF error when it reaches the end signalled by (nil, io.EOF), implementation must be thread-safe
	ReadNextAt(record proto.Message, offset uint64) (proto.Message, error)
}

this type is thread-safe

func NewMMapProtoReaderWithPath

func NewMMapProtoReaderWithPath(path string) (ReadAtI, error)

type Reader

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

func (*Reader) Close

func (r *Reader) Close() error

func (*Reader) Open

func (r *Reader) Open() error

func (*Reader) ReadNext

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

func (*Reader) SkipNext

func (r *Reader) SkipNext() error

type ReaderI

type ReaderI interface {
	recordio.OpenClosableI
	// Reads the next record into the passed message record, EOF error when it reaches the end signalled by (nil, io.EOF)
	ReadNext(record proto.Message) (proto.Message, error)
	// skips the next record, EOF error when it reaches the end signalled by io.EOF as the error
	SkipNext() error
}

func NewProtoReaderWithFile

func NewProtoReaderWithFile(file *os.File) (ReaderI, error)

func NewProtoReaderWithPath

func NewProtoReaderWithPath(path string) (ReaderI, error)

type Writer

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

func (*Writer) Close

func (w *Writer) Close() error

func (*Writer) Open

func (w *Writer) Open() error

func (*Writer) Size

func (w *Writer) Size() uint64

func (*Writer) Write

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

func (*Writer) WriteSync

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

type WriterI

type WriterI interface {
	recordio.OpenClosableI
	recordio.SizeI
	// Appends a record, returns the current offset this item was written to
	Write(record proto.Message) (uint64, error)
	// Appends a record and forces a disk sync, returns the current offset this item was written to
	WriteSync(record proto.Message) (uint64, error)
}

func NewWriter

func NewWriter(writerOptions ...WriterOption) (WriterI, error)

create a new writer with the given options. Either Path or File must be supplied, compression is optional and turned off by default.

type WriterOption

type WriterOption func(*WriterOptions)

func CompressionType

func CompressionType(p int) WriterOption

func DirectIO

func DirectIO() WriterOption

func File

func File(p *os.File) WriterOption

func Path

func Path(p string) WriterOption

func WriteBufferSizeBytes

func WriteBufferSizeBytes(p int) WriterOption

type WriterOptions

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