walk

Documentation

Overview

package walk provides methods for walking all in the records in a line-delimited JSON document.

Index

• Constants
• func IsEOFError(err error) bool
• func WalkBucket(ctx context.Context, opts *WalkOptions, bucket *blob.Bucket) error
• func WalkReader(ctx context.Context, opts *WalkOptions, fh io.Reader)
• type WalkError
  • func (e *WalkError) Error() string
  • func (e *WalkError) String() string
• type WalkFilterFunc
• type WalkOptions
• type WalkRecord

Constants

const CONTEXT_PATH string = "github.com/aaronland/go-jsonl#path"

Functions

func IsEOFError

func IsEOFError(err error) bool

func WalkBucket

func WalkBucket(ctx context.Context, opts *WalkOptions, bucket *blob.Bucket) error

func WalkReader

func WalkReader(ctx context.Context, opts *WalkOptions, fh io.Reader)

Types

type WalkError

type WalkError struct {
	Path       string
	LineNumber int
	Err        error
}

func (*WalkError) Error

func (e *WalkError) Error() string

func (*WalkError) String

func (e *WalkError) String() string

type WalkFilterFunc

type WalkFilterFunc func(context.Context, string) bool

type WalkOptions

type WalkOptions struct {
	URI                  string
	Workers              int
	RecordChannel        chan *WalkRecord
	ErrorChannel         chan *WalkError
	DoneChannel          chan bool
	SendCompletedChannel bool
	ValidateJSON         bool
	FormatJSON           bool
	QuerySet             *query.QuerySet
	IsBzip               bool
	Filter               WalkFilterFunc
}

type WalkRecord

type WalkRecord struct {
	Path             string
	LineNumber       int
	Body             []byte
	CompletedChannel chan bool
}