iox

Documentation

Index

• func CountLines(file string) (int, error)
• func DupReadCloser(reader io.ReadCloser) (io.ReadCloser, io.ReadCloser)
• func NopCloser(w io.Writer) io.WriteCloser
• func ReadBytes(reader io.Reader, buf []byte) error
• func ReadText(filename string) (string, error)
• func ReadTextLines(filename string, opts ...TextReadOption) ([]string, error)
• func RedirectInOut() (restore func(), err error)
• type BufferPool
  • func NewBufferPool(capability int) *BufferPool
  • func (bp *BufferPool) Get() *bytes.Buffer
  • func (bp *BufferPool) Put(buf *bytes.Buffer)
• type TextLineScanner
  • func NewTextLineScanner(reader io.Reader) *TextLineScanner
  • func (scanner *TextLineScanner) Line() (string, error)
  • func (scanner *TextLineScanner) Scan() bool
• type TextReadOption
  • func KeepSpace() TextReadOption
  • func OmitWithPrefix(prefix string) TextReadOption
  • func WithoutBlank() TextReadOption

Functions

func CountLines

func CountLines(file string) (int, error)

CountLines returns the number of lines in file.

func DupReadCloser

func DupReadCloser(reader io.ReadCloser) (io.ReadCloser, io.ReadCloser)

DupReadCloser returns two io.ReadCloser that read from the first will be written to the second. The first returned reader needs to be read first, because the content read from it will be written to the underlying buffer of the second reader.

func NopCloser

func NopCloser(w io.Writer) io.WriteCloser

NopCloser returns a io.WriteCloser that does nothing on calling Close.

func ReadBytes

func ReadBytes(reader io.Reader, buf []byte) error

ReadBytes reads exactly the bytes with the length of len(buf)

func ReadText

func ReadText(filename string) (string, error)

ReadText reads content from the given file with leading and tailing spaces trimmed.

func ReadTextLines

func ReadTextLines(filename string, opts ...TextReadOption) ([]string, error)

ReadTextLines reads the text lines from given file.

func RedirectInOut

func RedirectInOut() (restore func(), err error)

RedirectInOut redirects stdin to r, stdout to w, and callers need to call restore afterwards.

Types

type BufferPool

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

A BufferPool is a pool to buffer bytes.Buffer objects.

func NewBufferPool

func NewBufferPool(capability int) *BufferPool

NewBufferPool returns a BufferPool.

func (*BufferPool) Get

func (bp *BufferPool) Get() *bytes.Buffer

Get returns a bytes.Buffer object from bp.

func (*BufferPool) Put

func (bp *BufferPool) Put(buf *bytes.Buffer)

Put returns buf into bp.

type TextLineScanner

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

A TextLineScanner is a scanner that can scan lines from given reader.

func NewTextLineScanner

func NewTextLineScanner(reader io.Reader) *TextLineScanner

NewTextLineScanner returns a TextLineScanner with given reader.

func (*TextLineScanner) Line

func (scanner *TextLineScanner) Line() (string, error)

Line returns the next available line.

func (*TextLineScanner) Scan

func (scanner *TextLineScanner) Scan() bool

Scan checks if scanner has more lines to read.

type TextReadOption

type TextReadOption func(*textReadOptions)

TextReadOption defines the method to customize the text reading functions.

func KeepSpace

func KeepSpace() TextReadOption

KeepSpace customizes the reading functions to keep leading and tailing spaces.

func OmitWithPrefix

func OmitWithPrefix(prefix string) TextReadOption

OmitWithPrefix customizes the reading functions to ignore the lines with given leading prefix.

func WithoutBlank

func WithoutBlank() TextReadOption

WithoutBlank customizes the reading functions to ignore blank lines.