package acceptencoding

Import Path
	github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding (on go.dev)

Dependency Relation
	imports 7 packages, and imported by one package

Involved Source Files

	      accept_encoding_gzip.go
	   #d doc.go
		Package acceptencoding provides customizations associated with Accept Encoding Header.

		# Accept encoding gzip

		The Go HTTP client automatically supports accept-encoding and content-encoding
		gzip by default. This default behavior is not desired by the SDK, and prevents
		validating the response body's checksum. To prevent this the SDK must manually
		control usage of content-encoding gzip.

		To control content-encoding, the SDK must always set the `Accept-Encoding`
		header to a value. This prevents the HTTP client from using gzip automatically.
		When gzip is enabled on the API client, the SDK's customization will control
		decompressing the gzip data in order to not break the checksum validation. When
		gzip is disabled, the API client will disable gzip, preventing the HTTP
		client's default behavior.

		An `EnableAcceptEncodingGzip` option may or may not be present depending on the client using
		the below middleware. The option if present can be used to enable auto decompressing
		gzip by the SDK.

	      go_module_metadata.go
Package-Level Type Names (total 5, in which 4 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type AddAcceptEncodingGzipOptions (struct)
		AddAcceptEncodingGzipOptions provides the options for the
		AddAcceptEncodingGzip middleware setup.

		Fields (only one, which is exported)
			Enable bool
		As Inputs Of (at least one exported)
			func AddAcceptEncodingGzip(stack *middleware.Stack, options AddAcceptEncodingGzipOptions) error

	 type DecompressGzip (struct)
		DecompressGzip provides the middleware for decompressing a gzip
		response from the service.

		Methods (total 2, both are exported)
			(*DecompressGzip) HandleDeserialize(ctx context.Context, input middleware.DeserializeInput, next middleware.DeserializeHandler) (output middleware.DeserializeOutput, metadata middleware.Metadata, err error)
				HandleDeserialize implements the DeserializeMiddlware interface.

			(*DecompressGzip) ID() string
				ID returns the id for the middleware.

		Implements (at least 2, in which 1 are exported)
			*DecompressGzip : github.com/aws/smithy-go/middleware.DeserializeMiddleware
			/* at least one unexported ... *//* at least one unexported: */
			*DecompressGzip : github.com/aws/smithy-go/middleware.ider

	 type DisableGzip (struct)
		DisableGzip provides the middleware that will
		disable the underlying http client automatically enabling for gzip
		decompress content-encoding support.

		Methods (total 2, both are exported)
			(*DisableGzip) HandleFinalize(ctx context.Context, input middleware.FinalizeInput, next middleware.FinalizeHandler) (output middleware.FinalizeOutput, metadata middleware.Metadata, err error)
				HandleFinalize implements the FinalizeMiddleware interface.

			(*DisableGzip) ID() string
				ID returns the id for the middleware.

		Implements (at least 2, in which 1 are exported)
			*DisableGzip : github.com/aws/smithy-go/middleware.FinalizeMiddleware
			/* at least one unexported ... *//* at least one unexported: */
			*DisableGzip : github.com/aws/smithy-go/middleware.ider

	 type EnableGzip (struct)
		EnableGzip provides a middleware to enable support for
		gzip responses, with manual decompression. This prevents the underlying HTTP
		client from performing the gzip decompression automatically.

		Methods (total 2, both are exported)
			(*EnableGzip) HandleFinalize(ctx context.Context, input middleware.FinalizeInput, next middleware.FinalizeHandler) (output middleware.FinalizeOutput, metadata middleware.Metadata, err error)
				HandleFinalize implements the FinalizeMiddleware interface.

			(*EnableGzip) ID() string
				ID returns the id for the middleware.

		Implements (at least 2, in which 1 are exported)
			*EnableGzip : github.com/aws/smithy-go/middleware.FinalizeMiddleware
			/* at least one unexported ... *//* at least one unexported: */
			*EnableGzip : github.com/aws/smithy-go/middleware.ider

	/* one unexported ... *//* one unexported: */
	 type gzipReader (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			gzip *gzip.Reader
			reader io.ReadCloser
		Methods (total 2, both are exported)
			(*gzipReader) Close() error
			(*gzipReader) Read(b []byte) (n int, err error)
				Read wraps the gzip reader around the underlying io.Reader to extract the
				response bytes on the fly.

		Implements (at least 3, all are exported)
			*gzipReader : io.Closer
			*gzipReader : io.ReadCloser
			*gzipReader : io.Reader
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func wrapGzipReader(reader io.ReadCloser) *gzipReader


Package-Level Functions (total 2, in which 1 are exported)

	 func AddAcceptEncodingGzip(stack *middleware.Stack, options AddAcceptEncodingGzipOptions) error
		AddAcceptEncodingGzip explicitly adds handling for accept-encoding GZIP
		middleware to the operation stack. This allows checksums to be correctly
		computed without disabling GZIP support.

	/* one unexported ... *//* one unexported: */
	 func wrapGzipReader(reader io.ReadCloser) *gzipReader
Package-Level Constants (total 3, none are exported)

	/* 3 unexporteds ... *//* 3 unexporteds: */
	const acceptEncodingHeaderKey = "Accept-Encoding"
	const contentEncodingHeaderKey = "Content-Encoding"
	const goModuleVersion = "1.9.11"
		goModuleVersion is the tagged release for this module

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