bytestreamio

Documentation

Overview

Package bytestreamio provides io interfaces on bytestream service.

Index

• func Exists(ctx context.Context, c pb.ByteStreamClient, resourceName string) error
• type Reader
  • func Open(ctx context.Context, c pb.ByteStreamClient, resourceName string) (*Reader, error)
  • func (r *Reader) Read(buf []byte) (int, error)
  • func (r *Reader) Size() int64
• type Writer
  • func Create(ctx context.Context, c pb.ByteStreamClient, resourceName string) (*Writer, error)
  • func (w *Writer) Close() error
  • func (w *Writer) Write(buf []byte) (int, error)

Functions

func Exists

func Exists(ctx context.Context, c pb.ByteStreamClient, resourceName string) error

Exists checks for the existence of a resource by its resourceName.

Types

type Reader

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

Reader is a reader on bytestream and implements io.Reader.

func Open

func Open(ctx context.Context, c pb.ByteStreamClient, resourceName string) (*Reader, error)

Open opens a reader on the bytestream for the resourceName. ctx will be used until the reader is closed.

func (*Reader) Read

func (r *Reader) Read(buf []byte) (int, error)

Read reads data from bytestream. The maximum data chunk size would be determined by server side.

func (*Reader) Size

func (r *Reader) Size() int64

Size reports read size by Read.

type Writer

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

Writer is a writer on bytestream, and implemnets io.Writer.

func Create

func Create(ctx context.Context, c pb.ByteStreamClient, resourceName string) (*Writer, error)

Create creates a writer on the bytestream for resourceName. ctx will be used until the rriter is closed.

func (*Writer) Close

func (w *Writer) Close() error

Close closes the writer.

func (*Writer) Write

func (w *Writer) Write(buf []byte) (int, error)

Write writes data to bytestream. The maximum data chunk size would be determined by server side, so don't pass larger chunk than maximum data chunk size.