wrap

Documentation

Index

• func Bytes(b []byte, limit int) []byte
• func String(s string, limit int) string
• type Wrap
  • func NewWriter(limit int) *Wrap
  • func (w *Wrap) Bytes() []byte
  • func (w *Wrap) String() string
  • func (w *Wrap) Write(b []byte) (int, error)

Functions

func Bytes

func Bytes(b []byte, limit int) []byte

Bytes is shorthand for declaring a new default Wrap instance, used to immediately wrap a byte slice.

func String

func String(s string, limit int) string

String is shorthand for declaring a new default Wrap instance, used to immediately wrap a string.

Types

type Wrap

type Wrap struct {
	Limit         int
	Newline       []rune
	KeepNewlines  bool
	PreserveSpace bool
	TabWidth      int
	// contains filtered or unexported fields
}

func NewWriter

func NewWriter(limit int) *Wrap

NewWriter returns a new instance of a wrapping writer, initialized with default settings.

func (*Wrap) Bytes

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

Bytes returns the wrapped result as a byte slice.

func (*Wrap) String

func (w *Wrap) String() string

String returns the wrapped result as a string.

func (*Wrap) Write

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