persistence

Documentation

Index

• type Journal
  • func NewJournal(name string) (j *Journal, err error)
  • func (j Journal) Close()
  • func (j Journal) Fsck() error
  • func (j Journal) ReadMutation() (m string, err error)
  • func (j Journal) WriteMutation(m string) (err error)

Types

type Journal

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

Journal represents a file where doozer can save state. Doozer usally uses a list of multiple journals.

func NewJournal

func NewJournal(name string) (j *Journal, err error)

NewJournal opens the named file for synchronous I/O, creating it with mode 0640 if it does not exist and prepares it for logging operation. If successful, methods on the returned Journal can be used for I/O. It returns a Journal and an error, if any.

func (Journal) Close

func (j Journal) Close()

Close shuts down the journal.

func (Journal) Fsck

func (j Journal) Fsck() error

Fsck truncates the journal at the last read mutation. It removes data, so use with care.

func (Journal) ReadMutation

func (j Journal) ReadMutation() (m string, err error)

Retrieve reads the next mutation from the Journal. It returns the mutation and an error, if any. EOF is signaled by a nil mutation with err set to io.EOF

func (Journal) WriteMutation

func (j Journal) WriteMutation(m string) (err error)

Store writes the mutation to the Journal.