indent

README

indent

indent.Reader will prepend each line of underlying input with configured indentation.

example

This shows an example of indent usefulness.

The program:

package main

import (
	"strings"
	"io"
	"os"

	"github.com/wkhere/indent"
)

func main() {
	b := strings.NewReader(example)
	io.Copy(os.Stdout, strings.NewReader("new_root:\n"))
	io.Copy(os.Stdout, indent.NewReader(b, "    "))
}

const example = `
hey: I am yaml
key: val
	nested: something
`

produces the output:

new_root:
    
    hey: I am yaml
    key: val
        nested: something

Documentation

Index

• type Reader
  • func NewReader(r io.Reader, indent string) *Reader
  • func (r *Reader) Read(p []byte) (n int, err error)

Types

type Reader

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

Reader implements prepending each line with indentation.

func NewReader

func NewReader(r io.Reader, indent string) *Reader

NewReader returns a Reader which will prepend each line read from underlying reader with given indentation.

func (*Reader) Read

func (r *Reader) Read(p []byte) (n int, err error)

Read reads data into p, prepending each line with indentation. When err != nil (including EOF), n is usually > 0.