filebacked

Documentation

Overview

Provides file-backed collections.

File backing for collections. File format:

Length: 8 (uint64)
| kind: 2 (uint16)
| size: 8 (uint64)
| object: n (gob encoded)
| ...

Provides file-backed list.

// // New list. list := fb.NewList()

// // Append an object. err := list.Append(object)

// // Iterate the list. itr := list.Iter()

for {
    object, hasNext, err := itr.Next()
    if err != nil || !hasNext {
        break
    }
}

// // Iterate the list. itr := list.Iter()

for {
    person := Person{}
    hasNext, err := itr.NextWith(&person))
    if err != nil || !hasNext {
        break
    }
}

Index

• Constants
• Variables
• type Catalog
• type EmptyIterator
  • func (*EmptyIterator) Close()
  • func (*EmptyIterator) Error() error
  • func (*EmptyIterator) Len() int
  • func (*EmptyIterator) Next() (interface{}, bool, error)
  • func (*EmptyIterator) NextWith(object interface{}) (bool, error)
• type Iterator
• type List
  • func NewList() (list *List)
  • func (l *List) Append(object interface{}) (err error)
  • func (l *List) Close()
  • func (l *List) Iter() (itr Iterator)
  • func (l *List) Len() int
• type Reader
  • func (r *Reader) Close()
  • func (r *Reader) Error() error
  • func (r *Reader) Len() (length int)
  • func (r *Reader) Next() (object interface{}, hasNext bool, err error)
  • func (r *Reader) NextWith(object interface{}) (hasNext bool, err error)
• type Writer
  • func (w *Writer) Append(object interface{}) (err error)
  • func (w *Writer) Close()
  • func (w *Writer) Reader() (reader *Reader)

Constants

const (
	Extension = ".fb"
)

File extension.

Variables

var WorkingDir = "/tmp"

Working Directory.

Types

type Catalog

type Catalog struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Type catalog.

type EmptyIterator

type EmptyIterator struct {
}

Empty.

func (*EmptyIterator) Close

func (*EmptyIterator) Close()

Close the iterator.

func (*EmptyIterator) Error

func (*EmptyIterator) Error() error

Get associated error.

func (*EmptyIterator) Len

func (*EmptyIterator) Len() int

Length.

func (*EmptyIterator) Next

func (*EmptyIterator) Next() (interface{}, bool, error)

Next object.

func (*EmptyIterator) NextWith

func (*EmptyIterator) NextWith(object interface{}) (bool, error)

Next object.

type Iterator

type Iterator interface {
	// Length.
	Len() int
	// Next object.
	Next() (interface{}, bool, error)
	// Next object.
	NextWith(object interface{}) (bool, error)
	// Get associated error.
	Error() error
	// Close the iterator.
	Close()
}

Iterator.

type List

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

File-backed list.

func NewList

func NewList() (list *List)

List factory.

func (*List) Append

func (l *List) Append(object interface{}) (err error)

Append an object.

func (*List) Close

func (l *List) Close()

Close (delete) the list.

func (*List) Iter

func (l *List) Iter() (itr Iterator)

Get an iterator.

func (*List) Len

func (l *List) Len() int

Length. Number of objects.

type Reader

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

Reader.

func (*Reader) Close

func (r *Reader) Close()

Close the reader.

func (*Reader) Error

func (r *Reader) Error() error

Error.

func (*Reader) Len

func (r *Reader) Len() (length int)

Length. Number of objects in the list.

func (*Reader) Next

func (r *Reader) Next() (object interface{}, hasNext bool, err error)

Get the next object.

func (*Reader) NextWith

func (r *Reader) NextWith(object interface{}) (hasNext bool, err error)

Get the next object.

type Writer

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

Writer.

func (*Writer) Append

func (w *Writer) Append(object interface{}) (err error)

Append (write) object.

func (*Writer) Close

func (w *Writer) Close()

Close the writer.

func (*Writer) Reader

func (w *Writer) Reader() (reader *Reader)

Get a reader.