piecereader

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 Buffer
  • func NewBuffer(b []byte) *Buffer
  • func (b *Buffer) Close() error
  • func (b *Buffer) Length() int
  • func (b *Buffer) Read(p []byte) (int, error)
• type FileReader
  • func NewFileReader(offset, length int64, opener Opener) *FileReader
  • func (r *FileReader) Close() error
  • func (r *FileReader) Length() int
  • func (r *FileReader) Read(p []byte) (int, error)
• type Opener

Types

type Buffer

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

Buffer is a storage.PieceReader which reads a piece from an in-memory buffer.

func NewBuffer

func NewBuffer(b []byte) *Buffer

NewBuffer returns a new Buffer for b.

func (*Buffer) Close

func (b *Buffer) Close() error

Close noops.

func (*Buffer) Length

func (b *Buffer) Length() int

Length returns the length of the piece.

func (*Buffer) Read

func (b *Buffer) Read(p []byte) (int, error)

Read reads a piece into p.

type FileReader

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

FileReader is a storage.PieceReader which reads a piece from a file.

func NewFileReader

func NewFileReader(offset, length int64, opener Opener) *FileReader

NewFileReader creates a FileReader which reads a piece from f. f should not be used once it is given to a FileReader.

func (*FileReader) Close

func (r *FileReader) Close() error

Close closes the underlying file.

func (*FileReader) Length

func (r *FileReader) Length() int

Length returns the length of the piece.

func (*FileReader) Read

func (r *FileReader) Read(p []byte) (int, error)

Read reads a piece in p.

type Opener

type Opener interface {
	Open() (store.FileReader, error)
}

Opener opens files.