ditto::CollectionsEvent Class Reference

Provides information about the changes that have occurred in relation to an event delivered when observing the collections in a Store. More...

#include <CollectionsEvent.hpp>

Public Member Functions
	CollectionsEvent (const CollectionsEvent &)=delete
CollectionsEvent &	operator= (const CollectionsEvent &)=delete
	CollectionsEvent (CollectionsEvent &&) noexcept=default

Public Attributes
bool	is_initial
std::vector< Collection >	collections
std::vector< Collection >	old_collections
std::vector< std::size_t >	insertions
std::vector< std::size_t >	deletions
std::vector< std::size_t >	updates
std::vector< LiveQueryMove >	moves

Detailed Description

Provides information about the changes that have occurred in relation to an event delivered when observing the collections in a Store.

It contains information about the collections that are known about as well as the collections that were previously known about in the previous event, along with information about what collections have been inserted, deleted, updated, or moved since the last event.

Member Data Documentation

collections

std::vector<Collection> ditto::CollectionsEvent::collections

A list of all of the known collections.

deletions

std::vector<std::size_t> ditto::CollectionsEvent::deletions

A list of the indexes in the list of previously known about collections at which collections have been removed.

insertions

std::vector<std::size_t> ditto::CollectionsEvent::insertions

A list of the indexes in the list of currently known about collections at which new collections have been inserted.

is_initial

bool ditto::CollectionsEvent::is_initial

Indicates whether or not this is the first event to be delivered when observing collections in the store.

moves

std::vector<LiveQueryMove> ditto::CollectionsEvent::moves

A list of the tuples that provides the indexes, in relation to the list of previously known about collections, that already known about collections have moved from and the indexes, in relation to the list of currently known about collections, that the collections have moved to.

old_collections

std::vector<Collection> ditto::CollectionsEvent::old_collections

A list of all of the known collections at the time the previous event was delivered.

updates

std::vector<std::size_t> ditto::CollectionsEvent::updates

A list of the indexes in the list of currently known about collections at which pre-existing collections have been updated.