httpio

package

v0.34.1 Latest Latest Go to latest Published: Oct 12, 2023 License: BSD-3-Clause Imports: 8 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

Package httpio provides types for basic I/O interfaces over HTTP.

This section is empty.

This section is empty.

This section is empty.

type Option func(*config) error

func WithBasicAuth(usr, pwd string) Option

WithBasicAuth sets up a basic authentification scheme.

func WithClient(cli *http.Client) Option

WithClient sets up Reader to use a user-provided HTTP client.

By default, Reader uses an httpio-local default client.

func WithContext(ctx context.Context) Option

WithContext configures Reader to use a user-provided context.

By default, Reader uses context.Background.

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

Reader presents an HTTP resource as an io.Reader and io.ReaderAt.

func Open(uri string, opts ...Option) (r *Reader, err error)

Open returns a Reader from the provided URL.

func (r *Reader) Close() error

Close implements the io.Closer interface.

func (r *Reader) Name() string

Name returns the name of the file as presented to Open.

func (r *Reader) Read(p []byte) (int, error)

Read implements the io.Reader interface.

func (r *Reader) ReadAt(p []byte, off int64) (int, error)

ReadAt implements the io.ReaderAt interface.

func (r *Reader) Seek(offset int64, whence int) (int64, error)

Seek implements the io.Seeker interface.

func (r *Reader) Size() int64

Size returns the number of bytes available for reading via ReadAt.