blobio

Documentation

Overview

Package blobio provides IO operations for blob

Index

• Constants
• func EndWriteBlob(writer io.Writer) error
• func MarkBlob(store kv.Store, blobKey blob.Key, mark string) error
• func PutBlob(writer kv.Writer, blob *blob.Blob) error
• func UnmarkBlob(store kv.Store, blobKey blob.Key, mark string) error
• func WriteBlob(writer io.Writer, blob *blob.Blob) error
• type BlobIterator
  • func NewBlobIterator(store kv.Store, blobKeyHexPrefix string) (*BlobIterator, error)
  • func (bi *BlobIterator) Blob() (*blob.Blob, error)
  • func (bi *BlobIterator) Error() error
  • func (bi *BlobIterator) Next() bool
  • func (bi *BlobIterator) Release()
• type MarkIterator
  • func NewMarkIterator(store kv.Store, mark string) *MarkIterator
  • func (mi *MarkIterator) BlobKey() (*blob.Key, error)
  • func (mi *MarkIterator) Error() error
  • func (mi *MarkIterator) Next() bool
  • func (mi *MarkIterator) Release()
• type OptBlob
  • func GetBlob(reader kv.Reader, blobKey blob.Key) (*OptBlob, error)
  • func ReadBlob(reader io.Reader) (*OptBlob, error)

Constants

const (
	// FaultBlobMark mark indicates that a blob needs to be resent
	FaultBlobMark = "fault"
)

Functions

func EndWriteBlob

func EndWriteBlob(writer io.Writer) error

EndWriteBlob end the write stream

func MarkBlob

func MarkBlob(store kv.Store, blobKey blob.Key, mark string) error

MarkBlob mark a blob

func PutBlob

func PutBlob(writer kv.Writer, blob *blob.Blob) error

PutBlob store blob to kv writer

func UnmarkBlob

func UnmarkBlob(store kv.Store, blobKey blob.Key, mark string) error

UnmarkBlob delete mark to a blob

func WriteBlob

func WriteBlob(writer io.Writer, blob *blob.Blob) error

WriteBlob write blob to writer

Types

type BlobIterator

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

BlobIterator iterates blobs in kv store

func NewBlobIterator

func NewBlobIterator(store kv.Store, blobKeyHexPrefix string) (*BlobIterator, error)

NewBlobIterator create blob iterator

func (*BlobIterator) Blob

func (bi *BlobIterator) Blob() (*blob.Blob, error)

Blob returns current blob

func (*BlobIterator) Error

func (bi *BlobIterator) Error() error

Error returns error occurred

func (*BlobIterator) Next

func (bi *BlobIterator) Next() bool

Next advance iterator

func (*BlobIterator) Release

func (bi *BlobIterator) Release()

Release release resource alloced for iterator

type MarkIterator

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

MarkIterator iterates marked blob keys

func NewMarkIterator

func NewMarkIterator(store kv.Store, mark string) *MarkIterator

NewMarkIterator returns an iterator for all blob keys marked with mark

func (*MarkIterator) BlobKey

func (mi *MarkIterator) BlobKey() (*blob.Key, error)

BlobKey returns blob key

func (*MarkIterator) Error

func (mi *MarkIterator) Error() error

Error returns error occurred

func (*MarkIterator) Next

func (mi *MarkIterator) Next() bool

Next move iterator next

func (*MarkIterator) Release

func (mi *MarkIterator) Release()

Release release the iterator

type OptBlob

type OptBlob struct {
	V *blob.Blob
}

OptBlob presents optional blob.

func GetBlob

func GetBlob(reader kv.Reader, blobKey blob.Key) (*OptBlob, error)

GetBlob get blob from kv reader by key.

func ReadBlob

func ReadBlob(reader io.Reader) (*OptBlob, error)

ReadBlob read blob from reader