rwutil

Documentation

Overview

Copyright (c) 2016-2019 Uber Technologies, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (c) 2016-2019 Uber Technologies, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type CappedBuffer
  • func NewCappedBuffer(capacity int) *CappedBuffer
  • func (b *CappedBuffer) DrainInto(dst io.Writer) error
  • func (b *CappedBuffer) WriteAt(p []byte, pos int64) (n int, err error)
• type PlainReader
  • func (p PlainReader) Read(b []byte) (n int, err error)
• type PlainWriter
  • func (p PlainWriter) Write(b []byte) (n int, err error)

Types

type CappedBuffer

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

CappedBuffer is a buffer that returns errors if the buffer exceeds cap.

func NewCappedBuffer

func NewCappedBuffer(capacity int) *CappedBuffer

NewCappedBuffer creates a new CappedBuffer with the given capacity

func (*CappedBuffer) DrainInto

func (b *CappedBuffer) DrainInto(dst io.Writer) error

DrainInto copies/drains/empties contents of CappedBuffer into dst

func (*CappedBuffer) WriteAt

func (b *CappedBuffer) WriteAt(p []byte, pos int64) (n int, err error)

WriteAt writes the slice of bytes into CappedBuffer at given position

type PlainReader

type PlainReader []byte

PlainReader provides an io.Reader for a bytes slice. It intentionally does not provide any other methods.

func (PlainReader) Read

func (p PlainReader) Read(b []byte) (n int, err error)

Read always reads the entire underlying byte slice.

type PlainWriter

type PlainWriter []byte

PlainWriter provides an io.Writer for a bytes slice. It intentionally does not provide any other methods. Clients should initialize length with make.

func (PlainWriter) Write

func (p PlainWriter) Write(b []byte) (n int, err error)

Write writes all of b to p.