count

Documentation

Overview

Package count implements the core counters used in gowc.

Index

• type Bytes
  • func (b *Bytes) Write(data []byte) (int, error)
• type Chars
  • func (c *Chars) Write(data []byte) (int, error)
• type Lines
  • func (l *Lines) Write(data []byte) (int, error)
• type Result
  • func One(in io.Reader, name string) Result
  • func (r Result) Display(w io.Writer, toJSON bool) error
• type Results
  • func All(files []string) Results
  • func (r Results) Display(w io.Writer, toJSON bool) error
• type Words
  • func (w *Words) Write(data []byte) (int, error)

Types

type Bytes

type Bytes uint64

func (*Bytes) Write

func (b *Bytes) Write(data []byte) (int, error)

Write implements io.Writer for Bytes.

It doesn't actually write anything, but increments the byte count on every byte in data, allowing a Bytes to be used as dst in a call to io.Copy.

type Chars

type Chars uint64

func (*Chars) Write

func (c *Chars) Write(data []byte) (int, error)

Write implements io.Writer for Chars.

It doesn't actually write anything, but increments the char count on every utf8 rune in data, allowing a Chars to be used as dst in a call to io.Copy.

type Lines

type Lines uint64

func (*Lines) Write

func (l *Lines) Write(data []byte) (int, error)

Write implements io.Writer for Lines.

It doesn't actually write anything, but increments the line count on every newline in data, allowing a Lines to be used as dst in a call to io.Copy.

type Result

type Result struct {
	Err   error  `json:"-"`
	Name  string `json:"name"`
	Lines Lines  `json:"lines"`
	Bytes Bytes  `json:"bytes"`
	Words Words  `json:"words"`
	Chars Chars  `json:"chars"`
}

Result encodes the result of a counting operation on a file.

func One

func One(in io.Reader, name string) Result

One performs a counting operation on a single reader, returning the result and any error.

func (Result) Display

func (r Result) Display(w io.Writer, toJSON bool) error

Display outputs the Count as a pretty table to w.

type Results

type Results []Result

Results encodes multiple Results from different files.

func All

func All(files []string) Results

All performs counting operations on multiple files concurrently gathering up the results and returning.

func (Results) Display

func (r Results) Display(w io.Writer, toJSON bool) error

Display outputs the Results to w.

type Words

type Words uint64

func (*Words) Write

func (w *Words) Write(data []byte) (int, error)

Write implements io.Writer for Words.

It doesn't actually write anything, but increments the word count on every word in data, allowing a Words to be used as dst in a call to io.Copy.