package io

Import Path
	github.com/aws/smithy-go/transport/http/internal/io (on go.dev)

Dependency Relation
	imports 2 packages, and imported by one package

Involved Source Files

	      safe.go
Package-Level Type Names (total 2, neither is exported)

	/* sort exporteds by: alphabet | popularity */
	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type safeReadCloser (struct)
		safeReadCloser wraps a io.ReadCloser and presents an io.ReadCloser interface. When Close is called on safeReadCloser
		the underlying Close method will be executed, and then the reference to the reader will be dropped. This type
		is meant to be used with the net/http library which will retain a reference to the request body for the lifetime
		of a goroutine connection. Wrapping in this manner will ensure that no data race conditions are falsely reported.
		This type is thread-safe.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			closed bool
			mtx sync.Mutex
			readCloser io.ReadCloser
		Methods (total 2, both are exported)
			(*safeReadCloser) Close() error
				Close calls the underlying io.ReadCloser's Close method, removes the reference to the reader, and returns any error
				reported from Close. Subsequent calls to Close will always return a nil error.

			(*safeReadCloser) Read(p []byte) (n int, err error)
				Read reads up to len(p) bytes into p from the underlying read. If the reader is closed io.EOF will be returned.

		Implements (at least 3, all are exported)
			*safeReadCloser : io.Closer
			*safeReadCloser : io.ReadCloser
			*safeReadCloser : io.Reader

	 type safeWriteToReadCloser (struct)
		safeWriteToReadCloser wraps a safeReadCloser but exposes a WriteTo interface implementation. This will panic
		if the underlying io.ReadClose does not support WriteTo. Use NewSafeReadCloser to ensure the proper handling of this
		type.

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			safeReadCloser *safeReadCloser
			safeReadCloser.closed bool
			safeReadCloser.mtx sync.Mutex
			safeReadCloser.readCloser io.ReadCloser
		Methods (total 3, all are exported)
			( safeWriteToReadCloser) Close() error
				Close calls the underlying io.ReadCloser's Close method, removes the reference to the reader, and returns any error
				reported from Close. Subsequent calls to Close will always return a nil error.

			( safeWriteToReadCloser) Read(p []byte) (n int, err error)
				Read reads up to len(p) bytes into p from the underlying read. If the reader is closed io.EOF will be returned.

			(*safeWriteToReadCloser) WriteTo(w io.Writer) (int64, error)
				WriteTo implements the io.WriteTo interface.

		Implements (at least 4, all are exported)
			 safeWriteToReadCloser : io.Closer
			 safeWriteToReadCloser : io.ReadCloser
			 safeWriteToReadCloser : io.Reader
			*safeWriteToReadCloser : io.WriterTo


Package-Level Functions (only one, which is exported)

	 func NewSafeReadCloser(readCloser io.ReadCloser) io.ReadCloser
		NewSafeReadCloser returns a new safeReadCloser that wraps readCloser.

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)