possum

Documentation

Index

• Variables
• type FileInfo
  • func (f FileInfo) IsDir() bool
  • func (f FileInfo) ModTime() time.Time
  • func (f FileInfo) Mode() fs.FileMode
  • func (f FileInfo) Name() string
  • func (f FileInfo) Size() int64
  • func (f FileInfo) Sys() any
• type Handle
  • func Open(dir string) (handle *Handle, err error)
  • func (me *Handle) CleanupSnapshots() error
  • func (me *Handle) Close() error
  • func (me *Handle) DeletePrefix(prefix []byte) error
  • func (me *Handle) ListKeys(prefix string) (keys []string, err error)
  • func (me *Handle) MovePrefix(from, to []byte) error
  • func (me *Handle) NewReader() (r Reader, err error)
  • func (me *Handle) NewWriter() (w *Writer, err error)
  • func (me *Handle) PutBuf(key string, buf []byte) error
  • func (me *Handle) SetInstanceLimits(limits Limits) error
  • func (me *Handle) SingleDelete(key string) (fi generics.Option[FileInfo], err error)
  • func (me *Handle) SingleReadAt(key string, off int64, p []byte) (n int, err error)
  • func (me *Handle) SingleStat(key string) (fi FileInfo, ok bool)
• type Item
• type Limits
• type Rc
  • func NewRc[T any](t T, dropValue func(T)) (rc *Rc[T])
  • func (me *Rc[T]) Clone() (cloned *Rc[T])
  • func (me *Rc[T]) Deref() T
  • func (me *Rc[T]) Drop()
  • func (me *Rc[T]) Init(t T, dropValue func(T))
  • func (me *Rc[T]) ValueDropped() *chansync.SetOnce
• type Reader
  • func (r Reader) Add(key string) (v Value, err error)
  • func (r Reader) Begin() error
  • func (r Reader) Close() error
  • func (r Reader) End()
  • func (r Reader) ListItems(prefix string) ([]Item, error)
• type Value
  • func (v Value) ReadAt(p []byte, off int64) (n int, err error)
  • func (v Value) Stat() FileInfo
• type ValueWriter
  • func (me *ValueWriter) Fd() uintptr
  • func (me *ValueWriter) NewFile(name string) (f *os.File, err error)
• type Writer
  • func (me *Writer) Commit() error
  • func (me *Writer) Rename(v Value, newKey []byte)
  • func (me *Writer) Stage(key []byte, value *ValueWriter) error
  • func (me *Writer) StartNewValue() (vw *ValueWriter, err error)

Variables

var ErrHandleClosed = errors.New("possum Handle closed")

Types

type FileInfo

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

func (FileInfo) IsDir

func (f FileInfo) IsDir() bool

func (FileInfo) ModTime

func (f FileInfo) ModTime() time.Time

func (FileInfo) Mode

func (f FileInfo) Mode() fs.FileMode

func (FileInfo) Name

func (f FileInfo) Name() string

func (FileInfo) Size

func (f FileInfo) Size() int64

func (FileInfo) Sys

func (f FileInfo) Sys() any

type Handle

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

func Open

func Open(dir string) (handle *Handle, err error)

func (*Handle) CleanupSnapshots

func (me *Handle) CleanupSnapshots() error

func (*Handle) Close

func (me *Handle) Close() error

func (*Handle) DeletePrefix

func (me *Handle) DeletePrefix(prefix []byte) error

func (*Handle) ListKeys

func (me *Handle) ListKeys(prefix string) (keys []string, err error)

func (*Handle) MovePrefix

func (me *Handle) MovePrefix(from, to []byte) error

func (*Handle) NewReader

func (me *Handle) NewReader() (r Reader, err error)

func (*Handle) NewWriter

func (me *Handle) NewWriter() (w *Writer, err error)

func (*Handle) PutBuf

func (me *Handle) PutBuf(key string, buf []byte) error

func (*Handle) SetInstanceLimits

func (me *Handle) SetInstanceLimits(limits Limits) error

func (*Handle) SingleDelete

func (me *Handle) SingleDelete(key string) (fi generics.Option[FileInfo], err error)

func (*Handle) SingleReadAt

func (me *Handle) SingleReadAt(key string, off int64, p []byte) (n int, err error)

func (*Handle) SingleStat

func (me *Handle) SingleStat(key string) (fi FileInfo, ok bool)

type Item

type Item = possumC.Item

type Limits

type Limits = possumC.Limits

type Rc

type Rc[T any] struct {
	// contains filtered or unexported fields
}

func NewRc

func NewRc[T any](t T, dropValue func(T)) (rc *Rc[T])

func (*Rc[T]) Clone

func (me *Rc[T]) Clone() (cloned *Rc[T])

func (*Rc[T]) Deref

func (me *Rc[T]) Deref() T

Return the value. TODO: Should we allow modifying the value? In Rust we'd get a reference, but in Go we're more than likely working with a pointer resource, but it would be possible to do synchronization external to Rc to make it useful as a value type.

func (*Rc[T]) Drop

func (me *Rc[T]) Drop()

It's a logical error to do this more than once. Figure your shit out.

func (*Rc[T]) Init

func (me *Rc[T]) Init(t T, dropValue func(T))

func (*Rc[T]) ValueDropped

func (me *Rc[T]) ValueDropped() *chansync.SetOnce

The return is set when the inner value is dropped.

type Reader

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

func (Reader) Add

func (r Reader) Add(key string) (v Value, err error)

func (Reader) Begin

func (r Reader) Begin() error

func (Reader) Close

func (r Reader) Close() error

func (Reader) End

func (r Reader) End()

func (Reader) ListItems

func (r Reader) ListItems(prefix string) ([]Item, error)

type Value

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

func (Value) ReadAt

func (v Value) ReadAt(p []byte, off int64) (n int, err error)

func (Value) Stat

func (v Value) Stat() FileInfo

type ValueWriter

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

func (*ValueWriter) Fd

func (me *ValueWriter) Fd() uintptr

Should this be exposed?

func (*ValueWriter) NewFile

func (me *ValueWriter) NewFile(name string) (f *os.File, err error)

type Writer

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

func (*Writer) Commit

func (me *Writer) Commit() error

This consumes the Writer. You must commit a Writer after it's created or it will leak a reference to the Handle. There doesn't seem to be a way to abort it in the Go API.

func (*Writer) Rename

func (me *Writer) Rename(v Value, newKey []byte)

func (*Writer) Stage

func (me *Writer) Stage(key []byte, value *ValueWriter) error

func (*Writer) StartNewValue

func (me *Writer) StartNewValue() (vw *ValueWriter, err error)