streamquote

README

streamquote

This package provides a streaming version of strconv.Quote.

It allows you to quote the data in an io.Reader and write it out to an io.Writer without having to store the entire input and the entire output in memory.

Its primary use case is go.rice and similar tools, which need to convert lots of files, some of them quite large, to go strings.

converter := streamquote.New()
converter.Convert(inputfile, outfile)

Unlike strconv.Quote, it does not add quotes around the output.

Documentation

Overview

Package streamquote implements a streaming version of strconv.Quote.

Index

• type Converter
  • func New() Converter

Types

type Converter

type Converter interface {
	// Convert converts the data in "in", writing it to "out".
	// It uses Go escape sequences (\t, \n, \xFF, \u0100) for control characters
	// and non-printable characters as defined by strconv.IsPrint.
	// It is not safe for concurrent use.
	Convert(in io.Reader, out io.Writer) (int, error)
}

Converter converts data by escaping control characters and non-printable characters using Go escape sequences.

func New

func New() Converter

New returns a new Converter.