monotone

README

Monotone Client for Go

Monotone Client is wrapper native Monotone API using the awesome purego library to call C.

Installing

go get -u github.com/oskoi/monotone-go

Run Examples

• basic -- basic API usage.

clone repo and run container:

$ git clone https://github.com/oskoi/amelie-go && cd amelie-go
$ docker run --platform linux/amd64 -it -v ./:/home ubuntu:25.04

and run example in container:

$ apt-get update && apt-get install -y git golang libcurl4-openssl-dev
$ cd /home && go run examples/basic/main.go

Documentation

Index

• Variables
• type Cursor
  • func (c *Cursor) Key() *Event
  • func (c *Cursor) Read(n int) (events []*Event, err error)
  • func (c *Cursor) Stream() (iter.Seq[*Event], func() error)
• type Event
  • func (a *Event) Equal(b *Event) bool
  • func (e *Event) String() string
• type Monotone
  • func New() *Monotone
  • func (m *Monotone) Close()
  • func (m *Monotone) Cursor(key *Event, exclusive bool) (*Cursor, error)
  • func (m *Monotone) Delete(batch []*Event) error
  • func (m *Monotone) Error() error
  • func (m *Monotone) Execute(command string) ([]byte, error)
  • func (m *Monotone) Open(s string) error
  • func (m *Monotone) Read(key *Event, n int) ([]*Event, error)
  • func (m *Monotone) Write(batch []*Event) error

Variables

var ErrClosed = errors.New("closed")

Types

type Cursor

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

func (*Cursor) Key

func (c *Cursor) Key() *Event

func (*Cursor) Read

func (c *Cursor) Read(n int) (events []*Event, err error)

func (*Cursor) Stream

func (c *Cursor) Stream() (iter.Seq[*Event], func() error)

type Event

type Event struct {
	Id    uint64 `json:"id,omitempty"`
	Key   []byte `json:"key,omitempty"`
	Value []byte `json:"value,omitempty"`
}

func (*Event) Equal

func (a *Event) Equal(b *Event) bool

func (*Event) String

func (e *Event) String() string

type Monotone

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

func New

func New() *Monotone

func (*Monotone) Close

func (m *Monotone) Close()

func (*Monotone) Cursor

func (m *Monotone) Cursor(key *Event, exclusive bool) (*Cursor, error)

func (*Monotone) Delete

func (m *Monotone) Delete(batch []*Event) error

func (*Monotone) Error

func (m *Monotone) Error() error

func (*Monotone) Execute

func (m *Monotone) Execute(command string) ([]byte, error)

func (*Monotone) Open

func (m *Monotone) Open(s string) error

func (*Monotone) Read

func (m *Monotone) Read(key *Event, n int) ([]*Event, error)

func (*Monotone) Write

func (m *Monotone) Write(batch []*Event) error