...

Package io

import "github.com/aws/smithy-go/io"
Overview
Index

Overview ▾

Package io provides utilities for Smithy generated API clients.

Constants

const (
    // Byte is 8 bits
    Byte int64 = 1
    // KibiByte (KiB) is 1024 Bytes
    KibiByte = Byte * 1024
    // MebiByte (MiB) is 1024 KiB
    MebiByte = KibiByte * 1024
    // GibiByte (GiB) is 1024 MiB
    GibiByte = MebiByte * 1024
)

type ReadSeekNopCloser

ReadSeekNopCloser wraps an io.ReadSeeker with an additional Close method that does nothing.

type ReadSeekNopCloser struct {
    io.ReadSeeker
}

func (ReadSeekNopCloser) Close

func (ReadSeekNopCloser) Close() error

Close does nothing.

type RingBuffer

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.

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

func NewRingBuffer

func NewRingBuffer(slice []byte) *RingBuffer

NewRingBuffer method takes in a byte slice as an input and returns a RingBuffer.

func (RingBuffer) Bytes

func (r RingBuffer) Bytes() []byte

Bytes returns a copy of the RingBuffer's bytes.

func (*RingBuffer) Len

func (r *RingBuffer) Len() int

Len returns the number of unread bytes in the buffer.

func (*RingBuffer) Read

func (r *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.

func (*RingBuffer) Reset

func (r *RingBuffer) Reset()

Reset resets the ring buffer.

func (*RingBuffer) Write

func (r *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.