package io

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

Dependency Relation
	imports 2 packages, and imported by one package

Involved Source Files

	      byte.go
	   #d doc.go
		Package io provides utilities for Smithy generated API clients.

	      reader.go
	      ringbuffer.go
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type ReadSeekNopCloser (struct)
		ReadSeekNopCloser wraps an io.ReadSeeker with an additional Close method
		that does nothing.

		Fields (only one, which is exported)
			ReadSeeker io.ReadSeeker
		Methods (total 3, all are exported)
			( ReadSeekNopCloser) Close() error
				Close does nothing.

			( ReadSeekNopCloser) Read(p []byte) (n int, err error)
			( ReadSeekNopCloser) Seek(offset int64, whence int) (int64, error)
		Implements (at least 6, all are exported)
			 ReadSeekNopCloser : io.Closer
			 ReadSeekNopCloser : io.ReadCloser
			 ReadSeekNopCloser : io.Reader
			 ReadSeekNopCloser : io.ReadSeekCloser
			 ReadSeekNopCloser : io.ReadSeeker
			 ReadSeekNopCloser : io.Seeker

	 type RingBuffer (struct)
		RingBuffer struct satisfies io.ReadWrite interface.

		ReadBuffer is a revolving buffer data structure, which can be used to store snapshots of data in a
		revolving window.

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			end int
			size int
			slice []byte
			start int
		Methods (total 5, all are exported)
			( RingBuffer) Bytes() []byte
				Bytes returns a copy of the RingBuffer's bytes.

			(*RingBuffer) Len() int
				Len returns the number of unread bytes in the buffer.

			(*RingBuffer) Read(p []byte) (int, error)
				Read copies the data on the ring buffer into the byte slice provided to the method.
				Returns the read count along with any error encountered while reading.

			(*RingBuffer) Reset()
				Reset resets the ring buffer.

			(*RingBuffer) Write(p []byte) (int, error)
				Write method inserts the elements in a byte slice, and returns the number of bytes written along with any error.

		Implements (at least 5, in which 3 are exported)
			*RingBuffer : io.Reader
			*RingBuffer : io.ReadWriter
			*RingBuffer : io.Writer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*RingBuffer : golang.org/x/net/http2.pipeBuffer
			*RingBuffer : net/http.http2pipeBuffer
		As Outputs Of (at least one exported)
			func NewRingBuffer(slice []byte) *RingBuffer


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

	 func NewRingBuffer(slice []byte) *RingBuffer
		NewRingBuffer method takes in a byte slice as an input and returns a RingBuffer.


Package-Level Constants (total 4, all are exported)

	const Byte int64 = 1
		Byte is 8 bits

	const GibiByte int64 = 1073741824
		GibiByte (GiB) is 1024 MiB

	const KibiByte int64 = 1024
		KibiByte (KiB) is 1024 Bytes

	const MebiByte int64 = 1048576
		MebiByte (MiB) is 1024 KiB

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