contextio

Documentation

Overview

Package contextio provides io decorators that are context-aware.

Index

• func NewCloser(ctx context.Context, c io.Closer) io.Closer
• func NewReader(ctx context.Context, r io.Reader) io.Reader
• func NewWriter(ctx context.Context, w io.Writer) io.Writer

Functions

func NewCloser

func NewCloser(ctx context.Context, c io.Closer) io.Closer

NewCloser wraps an io.Reader to handle context cancellation.

The underlying io.Closer is closed even if the context is done.

func NewReader

func NewReader(ctx context.Context, r io.Reader) io.Reader

NewReader wraps an io.Reader to handle context cancellation.

Context state is checked BEFORE every Read.

If r implements io.ReadCloser, the returned reader will also implement io.ReadCloser.

func NewWriter

func NewWriter(ctx context.Context, w io.Writer) io.Writer

NewWriter wraps an io.Writer to handle context cancellation.

Context state is checked BEFORE every Write.

The returned Writer also implements io.ReaderFrom to allow io.Copy to select the best strategy while still checking the context state before every chunk transfer.

If w implements io.WriteCloser, the returned Writer will also implement io.WriteCloser.