streamer

package

v2.16.3 Latest Latest Go to latest Published: Apr 11, 2024 License: AGPL-3.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package streamer implements streaming of files over gRPC.

This section is empty.

This section is empty.

This section is empty.

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

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

func New(fs afero.Fs) *FileStreamer

New creates a new FileStreamer.

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 (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 interface {
	Recv() (*pb.Chunk, error)
}

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

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

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