iterator

Documentation

Index

• type EventIterator
• type GroupIterator
• type IndashIterator
• type Iterator
• type ObjectIterator
• type Paginator
• type TopicIterator
• type TopicNamesIterator

Types

type EventIterator

type EventIterator interface {
	Iterator
	Event() (*api.EventWrapper, error)
	Seek(eventID rlid.RLID) bool
}

EventIterator allows access to events in the database

type GroupIterator

type GroupIterator interface {
	Iterator
	Group() (*api.ConsumerGroup, error)
}

GroupIterator allows access to ConsumerGroup models in the datbase

type IndashIterator

type IndashIterator interface {
	Iterator
	Hash() ([]byte, error)
}

IndashIterator allows access to the event hashes in the database

type Iterator

type Iterator interface {
	Key() []byte
	Value() []byte
	Next() bool
	Prev() bool
	Error() error
	Release()
}

Iterators allow memory safe list operations from the Store.

type ObjectIterator

type ObjectIterator interface {
	Object() (interface{}, error)
}

ObjectIterator interfaces fetch the item at the cursor as an interface. Used primarily for testing iterators, the type-specific methods are used in production.

type Paginator

type Paginator interface {
	Page(*api.PageInfo) ([]interface{}, string, error)
}

Paginator iterators allow the fetching of multiple items at a time. Used primarily for testing paginated interfaces, the NextPage() methods are used in production.

type TopicIterator

type TopicIterator interface {
	Iterator
	Topic() (*api.Topic, error)
	NextPage(in *api.PageInfo) (*api.TopicsPage, error)
}

TopicIterator allows access to Topic models in the database

type TopicNamesIterator

type TopicNamesIterator interface {
	Iterator
	TopicName() (*api.TopicName, error)
	NextPage(in *api.PageInfo) (*api.TopicNamesPage, error)
}

TopicIterator allows access to Topic names index in the database