cursor

package

v0.16.1 Latest Latest Go to latest Published: Feb 1, 2022 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var (
	// ErrClosed means the cursor has been closed already.
	ErrClosed = errors.New("cursor closed")
)

This section is empty.

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

Cursor is a archive.Mail cursor.

func New(mails ...archive.Mail) *Cursor

New returns a new *Cursor, initialized with the provided mails.

func (cur *Cursor) All(ctx context.Context) ([]archive.Mail, error)

All returns the remaining archive.Mails from the Cursor and calls cur.Close(ctx) afterwards.

It fails with ErrClosed if cur.Close() has been called before.

func (cur *Cursor) Close(ctx context.Context) error

Close closes the Cursor and puts it in an unusable state. It fails with ErrClosed if cur.Close() has been called before.

func (cur *Cursor) Current() archive.Mail

Current returns the current archive.Mail.

func (cur *Cursor) Err() error

Err always returns nil.

func (cur *Cursor) Next(ctx context.Context) bool

Next tries to advance the Cursor to the next mail. It returns false if the Cursor is already at the end, otherwise it returns true.

func (cur *Cursor) Push(mails ...archive.Mail) error

Push adds mails to the end of the Cursor. It fails with ErrClosed if cur.Close() has been called before.