padding

Documentation

Index

• func Bytes(b []byte, width uint) []byte
• func String(s string, width uint) string
• type PaddingFunc
• type Writer
  • func NewWriter(width uint, paddingFunc PaddingFunc) *Writer
  • func NewWriterPipe(forward io.Writer, width uint, paddingFunc PaddingFunc) *Writer
  • func (w *Writer) Bytes() []byte
  • func (w *Writer) Close() (err error)
  • func (w *Writer) Flush() (err error)
  • func (w *Writer) String() string
  • func (w *Writer) Write(b []byte) (int, error)

Functions

func Bytes

func Bytes(b []byte, width uint) []byte

Bytes is shorthand for declaring a new default padding-writer instance, used to immediately pad a byte slice.

func String

func String(s string, width uint) string

String is shorthand for declaring a new default padding-writer instance, used to immediately pad a string.

Types

type PaddingFunc

type PaddingFunc func(w io.Writer)

type Writer

type Writer struct {
	Padding uint
	PadFunc PaddingFunc
	// contains filtered or unexported fields
}

func NewWriter

func NewWriter(width uint, paddingFunc PaddingFunc) *Writer

func NewWriterPipe

func NewWriterPipe(forward io.Writer, width uint, paddingFunc PaddingFunc) *Writer

func (*Writer) Bytes

func (w *Writer) Bytes() []byte

Bytes returns the padded result as a byte slice.

func (*Writer) Close

func (w *Writer) Close() (err error)

Close will finish the padding operation.

func (*Writer) Flush

func (w *Writer) Flush() (err error)

Flush will finish the padding operation. Always call it before trying to retrieve the final result.

func (*Writer) String

func (w *Writer) String() string

String returns the padded result as a string.

func (*Writer) Write

func (w *Writer) Write(b []byte) (int, error)

Write is used to write content to the padding buffer.