limitbuf

Documentation

Overview

Package limitbuf provides a sticky-error string builder with a hard byte limit. It is useful in renderers whose WriteString errors are intentionally ignored at individual call sites.

Index

• Variables
• type Buffer
  • func New(limit int) *Buffer
  • func (b *Buffer) Err() error
  • func (b *Buffer) Len() int
  • func (b *Buffer) String() string
  • func (b *Buffer) Write(p []byte) (int, error)
  • func (b *Buffer) WriteByte(c byte) error
  • func (b *Buffer) WriteRune(r rune) (int, error)
  • func (b *Buffer) WriteString(s string) (int, error)

Variables

var ErrTooLarge = errors.New("buffer exceeds size limit")

ErrTooLarge reports that a write would exceed a Buffer's byte limit.

Types

type Buffer

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

Buffer accumulates text up to limit bytes. A non-positive limit is unlimited. Once a write would exceed the limit, all later writes return the same sticky error and no partial write is retained.

func New

func New(limit int) *Buffer

New returns an empty Buffer with the supplied byte limit.

func (*Buffer) Err

func (b *Buffer) Err() error

Err returns the first size error encountered by the Buffer.

func (*Buffer) Len

func (b *Buffer) Len() int

Len returns the number of retained bytes.

func (*Buffer) String

func (b *Buffer) String() string

func (*Buffer) Write

func (b *Buffer) Write(p []byte) (int, error)

func (*Buffer) WriteByte

func (b *Buffer) WriteByte(c byte) error

WriteByte appends c if it fits within the byte limit.

func (*Buffer) WriteRune

func (b *Buffer) WriteRune(r rune) (int, error)

WriteRune appends r if its UTF-8 encoding fits within the byte limit.

func (*Buffer) WriteString

func (b *Buffer) WriteString(s string) (int, error)

WriteString appends s if it fits within the byte limit.