package arrio

Import Path
	github.com/apache/arrow-go/v18/arrow/arrio (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	  d arrio.go
		Package arrio exposes functions to manipulate records, exposing and using
		interfaces not unlike the ones defined in the stdlib io package.
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Reader (interface)
		Reader is the interface that wraps the Read method.

		Methods (only one)
			( Reader) Read() (arrow.RecordBatch, error)
				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).

		Implemented By (at least 2)
			*github.com/apache/arrow-go/v18/arrow/ipc.FileReader
			*github.com/apache/arrow-go/v18/arrow/ipc.Reader
		As Inputs Of (at least 2)
			func Copy(dst Writer, src Reader) (n int64, err error)
			func CopyN(dst Writer, src Reader, n int64) (written int64, err error)

	 type ReaderAt (interface)
		ReaderAt is the interface that wraps the ReadAt method.

		Methods (only one)
			( ReaderAt) ReadAt(i int64) (arrow.RecordBatch, error)
				ReadAt reads the i-th record from the underlying stream and an error, if any.

		Implemented By (at least one exported)
			*github.com/apache/arrow-go/v18/arrow/ipc.FileReader

	 type Writer (interface)
		Writer is the interface that wraps the Write method.

		Methods (only one)
			( Writer) Write(rec arrow.RecordBatch) error
		Implemented By (at least 2)
			*github.com/apache/arrow-go/v18/arrow/ipc.FileWriter
			*github.com/apache/arrow-go/v18/arrow/ipc.Writer
		As Inputs Of (at least 2)
			func Copy(dst Writer, src Reader) (n int64, err error)
			func CopyN(dst Writer, src Reader, n int64) (written int64, err error)


Package-Level Functions (total 2)

	 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(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.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.