bufferedwriter

Documentation

Index

• func Put(bw *Writer)
• type Writer
  • func Get(w io.Writer) *Writer
  • func (bw *Writer) Error() error
  • func (bw *Writer) Flush() error
  • func (bw *Writer) Write(p []byte) (int, error)

Functions

func Put

func Put(bw *Writer)

Put returns back bw to the pool.

bw cannot be used after returning to the pool.

Types

type Writer

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

Writer is buffered writer, which may be used in order to reduce overhead when sending moderately big responses to http server.

Writer methods can be called from concurrently running goroutines. The writer remembers the first occurred error, which can be inspected with Error method.

func Get

func Get(w io.Writer) *Writer

Get returns buffered writer for the given w.

The writer must be returned to the pool after use by calling Put().

func (*Writer) Error

func (bw *Writer) Error() error

Error returns the first occurred error in bw.

func (*Writer) Flush

func (bw *Writer) Flush() error

Flush flushes bw to the underlying writer.

Connection close errors are ignored to not trigger on them and to not write to logs, but Write method doesn't ignore them since it may lead to an unexpected behaviour (see https://github.com/VictoriaMetrics/VictoriaMetrics/pull/8157)

func (*Writer) Write

func (bw *Writer) Write(p []byte) (int, error)

Write writes p to bw.