arrio

Documentation

Overview

Package arrio exposes functions to manipulate records, exposing and using interfaces not unlike the ones defined in the stdlib io package.

Index

• func Copy(dst Writer, src Reader) (n int64, err error)
• func CopyN(dst Writer, src Reader, n int64) (written int64, err error)
• type Reader
• type ReaderAt
• type Writer

Functions

func Copy

func Copy(dst Writer, src Reader) (n int64, err error)

Copy copies all the records available from src to dst. Copy returns the number of records copied and the first error encountered while copying, if any.

A successful Copy returns err == nil, not err == EOF. Because Copy is defined to read from src until EOF, it does not treat an EOF from Read as an error to be reported.

func CopyN

func CopyN(dst Writer, src Reader, n int64) (written int64, err error)

CopyN copies n records (or until an error) from src to dst. It returns the number of records copied and the earliest error encountered while copying. On return, written == n if and only if err == nil.

Types

type Reader

type Reader interface {
	// Read reads the current record from the underlying stream and an error, if any.
	// When the Reader reaches the end of the underlying stream, it returns (nil, io.EOF).
	Read() (arrow.Record, error)
}

Reader is the interface that wraps the Read method.

type ReaderAt

type ReaderAt interface {
	// ReadAt reads the i-th record from the underlying stream and an error, if any.
	ReadAt(i int64) (arrow.Record, error)
}

ReaderAt is the interface that wraps the ReadAt method.

type Writer

type Writer interface {
	Write(rec arrow.Record) error
}

Writer is the interface that wraps the Write method.