ioctx

package

v0.0.11 Latest Latest Go to latest Published: Mar 7, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/grailbio/base

Links

Open Source Insights

Documentation ¶

Overview ¶

ioctx adds context.Context to io APIs.

TODO: Specify policy for future additions to this package. It may be best to only add analogues of the stdlib "io" so ioctx.* are easy for readers to understand. New functions and types (other than conversions to and from stdlib types) should be added elsewhere.

Index ¶

func ToStdCloser(ctx context.Context, c Closer) io.Closer
func ToStdReadCloser(ctx context.Context, rc ReadCloser) io.ReadCloser
func ToStdReadSeeker(ctx context.Context, rs ReadSeeker) io.ReadSeeker
func ToStdReader(ctx context.Context, r Reader) io.Reader
func ToStdReaderAt(ctx context.Context, r ReaderAt) io.ReaderAt
func ToStdSeeker(ctx context.Context, s Seeker) io.Seeker
func ToStdWriter(ctx context.Context, w Writer) io.Writer
func ToStdWriterAt(ctx context.Context, w WriterAt) io.WriterAt
type Closer
- func FromStdCloser(c io.Closer) Closer
type ReadCloser
- func FromStdReadCloser(rc io.ReadCloser) ReadCloser
type ReadSeeker
- func FromStdReadSeeker(rs io.ReadSeeker) ReadSeeker
type Reader
- func FromStdReader(r io.Reader) Reader
type ReaderAt
- func FromStdReaderAt(r io.ReaderAt) ReaderAt
type Seeker
- func FromStdSeeker(s io.Seeker) Seeker
type StdCloser
- func (c StdCloser) Close() error
type StdReadCloser
type StdReader
- func (r StdReader) Read(dst []byte) (n int, err error)
type StdReaderAt
- func (r StdReaderAt) ReadAt(dst []byte, off int64) (n int, err error)
type StdSeeker
- func (r StdSeeker) Seek(offset int64, whence int) (int64, error)
type StdWriter
- func (w StdWriter) Write(p []byte) (n int, err error)
type StdWriterAt
- func (w StdWriterAt) WriteAt(dst []byte, off int64) (n int, err error)
type Writer
- func FromStdWriter(w io.Writer) Writer
type WriterAt

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ToStdCloser ¶

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

ToStdCloser wraps Closer as io.Closer.

func ToStdReadCloser ¶

func ToStdReadCloser(ctx context.Context, rc ReadCloser) io.ReadCloser

ToStdReadCloser wraps ReadCloser as io.ReadCloser.

func ToStdReadSeeker ¶

func ToStdReadSeeker(ctx context.Context, rs ReadSeeker) io.ReadSeeker

ToStdReadSeeker wraps ReadSeeker as io.ReadSeeker.

func ToStdReader ¶

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

ToStdReader wraps Reader as io.Reader.

func ToStdReaderAt ¶

func ToStdReaderAt(ctx context.Context, r ReaderAt) io.ReaderAt

ToStdReaderAt wraps ReaderAt as io.ReaderAt.

func ToStdSeeker ¶

func ToStdSeeker(ctx context.Context, s Seeker) io.Seeker

ToStdSeeker wraps Seeker as io.Seeker.

func ToStdWriter ¶

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

ToStdWriter wraps Writer as io.Writer.

func ToStdWriterAt ¶

func ToStdWriterAt(ctx context.Context, w WriterAt) io.WriterAt

ToStdWriterAt wraps WriterAt as io.WriterAt.

Types ¶

type Closer ¶

type Closer interface {
	Close(context.Context) error
}

Closer is io.Closer with context added.

func FromStdCloser ¶

func FromStdCloser(c io.Closer) Closer

FromStdCloser wraps io.Closer as Closer.

type ReadCloser ¶

type ReadCloser interface {
	Reader
	Closer
}

func FromStdReadCloser ¶

func FromStdReadCloser(rc io.ReadCloser) ReadCloser

FromStdReadCloser wraps io.ReadCloser as ReadCloser.

type ReadSeeker ¶

type ReadSeeker interface {
	Reader
	Seeker
}

ReadSeeker is io.ReadSeeker with context added.

func FromStdReadSeeker ¶

func FromStdReadSeeker(rs io.ReadSeeker) ReadSeeker

FromStdReadSeeker wraps io.ReadSeeker as ReadSeeker.

type Reader ¶

type Reader interface {
	Read(context.Context, []byte) (n int, err error)
}

Reader is io.Reader with context added.

func FromStdReader ¶

func FromStdReader(r io.Reader) Reader

FromStdReader wraps io.Reader as Reader.

type ReaderAt ¶

type ReaderAt interface {
	ReadAt(_ context.Context, dst []byte, off int64) (n int, err error)
}

ReaderAt is io.ReaderAt with context added.

func FromStdReaderAt ¶

func FromStdReaderAt(r io.ReaderAt) ReaderAt

FromStdReaderAt wraps io.ReaderAt as ReaderAt.

type Seeker ¶

type Seeker interface {
	Seek(_ context.Context, offset int64, whence int) (int64, error)
}

Seeker is io.Seeker with context added.

func FromStdSeeker ¶

func FromStdSeeker(s io.Seeker) Seeker

FromStdSeeker wraps io.Seeker as Seeker.

type StdCloser ¶

type StdCloser struct {
	Ctx context.Context
	Closer
}

func (StdCloser) Close ¶

func (c StdCloser) Close() error

type StdReadCloser ¶

type StdReadCloser struct {
	Ctx context.Context
	ReadCloser
}

type StdReader ¶

type StdReader struct {
	Ctx context.Context
	Reader
}

func (StdReader) Read ¶

func (r StdReader) Read(dst []byte) (n int, err error)

type StdReaderAt ¶

type StdReaderAt struct {
	Ctx context.Context
	ReaderAt
}

func (StdReaderAt) ReadAt ¶

func (r StdReaderAt) ReadAt(dst []byte, off int64) (n int, err error)

type StdSeeker ¶

type StdSeeker struct {
	Ctx context.Context
	Seeker
}

func (StdSeeker) Seek ¶

func (r StdSeeker) Seek(offset int64, whence int) (int64, error)

type StdWriter ¶

type StdWriter struct {
	Ctx context.Context
	Writer
}

func (StdWriter) Write ¶

func (w StdWriter) Write(p []byte) (n int, err error)

type StdWriterAt ¶

type StdWriterAt struct {
	Ctx context.Context
	WriterAt
}

func (StdWriterAt) WriteAt ¶

func (w StdWriterAt) WriteAt(dst []byte, off int64) (n int, err error)

type Writer ¶

type Writer interface {
	Write(context.Context, []byte) (n int, err error)
}

Writer is io.Writer with context added.

func FromStdWriter ¶

func FromStdWriter(w io.Writer) Writer

FromStdWriter wraps io.Writer as Writer.

type WriterAt ¶

type WriterAt interface {
	WriteAt(_ context.Context, p []byte, off int64) (n int, err error)
}

WriterAt is io.WriterAt with context added.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
fsctx fsctx adds context.Context to io/fs APIs.	fsctx adds context.Context to io/fs APIs.
spliceio

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL