fileutils

Documentation

Overview

Package fileutils defines generic file utilities.

Index

• type ContextualReaderWrapper
  • func NewContextualReaderWrapper(ctx context.Context, reader io.Reader) *ContextualReaderWrapper
  • func (c *ContextualReaderWrapper) Read(p []byte) (n int, err error)

Types

type ContextualReaderWrapper

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

ContextualReaderWrapper is a wrapper around an existing io.Reader that allows for the interruption of reads with the cancellation of a context.

func NewContextualReaderWrapper

func NewContextualReaderWrapper(ctx context.Context, reader io.Reader) *ContextualReaderWrapper

NewContextualReaderWrapper initializes a new ContextualReaderWrapper.

func (*ContextualReaderWrapper) Read

func (c *ContextualReaderWrapper) Read(p []byte) (n int, err error)

Read calls io.Reader.Read on the wrapped reader, allowing for interruption from a cancellation of the context.