streamer

Documentation

Overview

Package streamer implements streaming of files over gRPC.

Index

• type FileStreamer
  • func New(fs afero.Fs) *FileStreamer
  • func (f *FileStreamer) ReadStream(filename string, stream WriteChunkStream, chunksize uint, showProgress bool) error
  • func (f *FileStreamer) WriteStream(filename string, stream ReadChunkStream, showProgress bool) error
• type ReadChunkStream
• type WriteChunkStream

Types

type FileStreamer

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

FileStreamer handles reading and writing of a file using a stream of chunks.

func New

func New(fs afero.Fs) *FileStreamer

New creates a new FileStreamer.

func (*FileStreamer) ReadStream

func (f *FileStreamer) ReadStream(filename string, stream WriteChunkStream, chunksize uint, showProgress bool) error

ReadStream opens a file to read from and streams its contents chunkwise over gRPC.

func (*FileStreamer) WriteStream

func (f *FileStreamer) WriteStream(filename string, stream ReadChunkStream, showProgress bool) error

WriteStream opens a file to write to and streams chunks from a gRPC stream into the file.

type ReadChunkStream

type ReadChunkStream interface {
	Recv() (*pb.Chunk, error)
}

ReadChunkStream is abstraction over a gRPC stream that allows us to receive chunks via gRPC.

type WriteChunkStream

type WriteChunkStream interface {
	Send(chunk *pb.Chunk) error
}

WriteChunkStream is abstraction over a gRPC stream that allows us to send chunks via gRPC.