seqio

Documentation

Overview

Package seqio is an experimental package providing Seq interoperability with standard Go IO interfaces like io.Reader and bufio.Scanner.

Index

• type BufferOpt
• type BufferSeq
  • func LinesOf(r io.Reader) BufferSeq
  • func ReaderOf(r io.Reader, buf []byte) BufferSeq
  • func ScannerOf(r io.Reader, split bufio.SplitFunc, buf []byte, maxBuf int) BufferSeq
• type BufferSlice
• type Reader
  • func (r Reader) ByteLen() (int, bool)
  • func (r Reader) First() (opt.Opt[[]byte], BufferSeq)
  • func (r Reader) ForEach(f seq.Func1[[]byte]) BufferOpt
  • func (r Reader) ForEachIndex(f seq.Func2[int, []byte]) BufferOpt
  • func (r Reader) Len() (int, bool)
  • func (r Reader) Limit(n int) BufferSeq
  • func (r Reader) Map(shaper seq.FuncMap[[]byte, []byte]) BufferSeq
  • func (r Reader) Skip(n int) BufferSeq
  • func (r Reader) Take(n int) (BufferSlice, BufferSeq)
  • func (r Reader) TakeWhile(pred seq.Predicate[[]byte]) (BufferSlice, BufferSeq)
  • func (r Reader) ToSlice() BufferSlice
  • func (r Reader) Where(pred seq.Predicate[[]byte]) BufferSeq
  • func (r Reader) While(pred seq.Predicate[[]byte]) BufferSeq

Types

type BufferOpt

type BufferOpt = opt.Opt[[]byte]

type BufferSeq

type BufferSeq = seq.Seq[[]byte]

func LinesOf

func LinesOf(r io.Reader) BufferSeq

LinesOf returns a stateful seq splitting an io.Reader into lines using a standard bufio.Scanner.

func ReaderOf

func ReaderOf(r io.Reader, buf []byte) BufferSeq

ReaderOf creates a stateful seq.Seq wrapping an io.Reader. A buffer to use may optionally be provided.

Errors can be detected be using seq.Error() on seqs and opts returned from the reader's methods.

func ScannerOf

func ScannerOf(r io.Reader, split bufio.SplitFunc, buf []byte, maxBuf int) BufferSeq

ScannerOf creates a stateful seq splits a io.Reader into delimited chunks. If you want to split a reader into lines you can use LinesOf.

type BufferSlice

type BufferSlice = seq.Slice[[]byte]

type Reader

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

func (Reader) ByteLen

func (r Reader) ByteLen() (int, bool)

ByteLen on a Reader is unknown, unless the underlying io.Reader is an *os.File or if it is a something with a Len() int method, like a bytes.Buffer.

func (Reader) First

func (r Reader) First() (opt.Opt[[]byte], BufferSeq)

func (Reader) ForEach

func (r Reader) ForEach(f seq.Func1[[]byte]) BufferOpt

func (Reader) ForEachIndex

func (r Reader) ForEachIndex(f seq.Func2[int, []byte]) BufferOpt

ForEachIndex on a Reader sequence passes the stream offset, not the iteration index to f.

func (Reader) Len

func (r Reader) Len() (int, bool)

Len on a Reader is unknown, unless the underlying io.Reader is an *os.File or something with a Len() int method, in which case it returns the number of buffers this Seq will produce when executed.

func (Reader) Limit

func (r Reader) Limit(n int) BufferSeq

func (Reader) Map

func (r Reader) Map(shaper seq.FuncMap[[]byte, []byte]) BufferSeq

func (Reader) Skip

func (r Reader) Skip(n int) BufferSeq

func (Reader) Take

func (r Reader) Take(n int) (BufferSlice, BufferSeq)

func (Reader) TakeWhile

func (r Reader) TakeWhile(pred seq.Predicate[[]byte]) (BufferSlice, BufferSeq)

func (Reader) ToSlice

func (r Reader) ToSlice() BufferSlice

func (Reader) Where

func (r Reader) Where(pred seq.Predicate[[]byte]) BufferSeq

func (Reader) While

func (r Reader) While(pred seq.Predicate[[]byte]) BufferSeq