boundedbuffer

Documentation

Overview

Package boundedbuffer provides an io.Writer that retains at most a fixed number of bytes while reporting the original write lengths to its producer.

Index

• type Buffer
  • func New(retention *boundedbufferv1.Retention) (*Buffer, error)
  • func (b *Buffer) Bytes() []byte
  • func (b *Buffer) String() string
  • func (b *Buffer) Truncated() bool
  • func (b *Buffer) Write(data []byte) (int, error)

Types

type Buffer

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

Buffer captures bounded command diagnostics without applying backpressure.

func New

func New(retention *boundedbufferv1.Retention) (*Buffer, error)

New constructs a Buffer from a validated retention policy.

func (*Buffer) Bytes

func (b *Buffer) Bytes() []byte

Bytes returns the retained prefix. The returned slice aliases the Buffer.

func (*Buffer) String

func (b *Buffer) String() string

String returns the retained prefix and marks it when bytes were discarded.

func (*Buffer) Truncated

func (b *Buffer) Truncated() bool

Truncated reports whether bytes were discarded after the retention bound.

func (*Buffer) Write

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

Write retains the prefix that fits and reports the full input length so callers such as os/exec can continue draining process output.