recordio

Documentation

Overview

Package recordio implements the Mesos variant of RecordIO framing, whereby each record is prefixed by a line that indicates the length of the record in decimal ASCII. The bytes of the record immediately follow the length-line. Zero-length records are allowed.

Example

package main

import (
	"fmt"
	"io"
	"strings"

	"github.com/mesos/mesos-go/api/v1/lib/recordio"
)

func main() {
	var (
		r     = recordio.NewReader(strings.NewReader("6\nhello 0\n6\nworld!"))
		lines []string
	)
	for {
		fr, err := r.ReadFrame()
		if err == io.EOF {
			break
		}
		if err != nil {
			panic(err)
		}
		lines = append(lines, string(fr))
	}
	fmt.Println(lines)
}

Output:

[hello  world!]

Index

• func NewReader(read io.Reader, opt ...Opt) framing.Reader
• func ParseUintBytes(s []byte, base int, bitSize int) (n uint64, err error)
• type Opt
  • func MaxMessageSize(max int) Opt
• type Writer
  • func NewWriter(out io.Writer) *Writer
  • func (w *Writer) WriteFrame(b []byte) (err error)

Examples

• Package

Functions

func NewReader

func NewReader(read io.Reader, opt ...Opt) framing.Reader

NewReader returns a reader that parses frames from a recordio stream.

func ParseUintBytes

func ParseUintBytes(s []byte, base int, bitSize int) (n uint64, err error)

ParseUintBytes is like strconv.ParseUint, but using a []byte.

Types

type Opt

type Opt func(*reader)

func MaxMessageSize

func MaxMessageSize(max int) Opt

MaxMessageSize returns a functional option that configures the internal Scanner's buffer and max token (message) length, in bytes.

type Writer

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

func NewWriter

func NewWriter(out io.Writer) *Writer

func (*Writer) WriteFrame

func (w *Writer) WriteFrame(b []byte) (err error)