Suggest ignoring versions older than getOldestVersion

This commit is contained in:
2024-05-09 17:00:32 -07:00
parent b89b7b7f8e
commit 456b8f9c96

View File

@@ -88,9 +88,10 @@ struct VersionedMap {
/** Iterates through a canonicalized[1] view of all the mutations
* from `oldestVersion` to the iterator's version. There may be mutations from
* versions < `oldestVersion`, but they won't affect the result. It's
* thread-safe to operate on an iterator concurrently with any method of
* `VersionedMap`, as long as it's not invalidated by `setOldestVersion`.
* versions < `oldestVersion`, but they won't affect the result, and can be
* ignored if desired. It's thread-safe to operate on an iterator concurrently
* with any method of `VersionedMap`, as long as it's not invalidated by
* `setOldestVersion`.
* @warning must not outlive its `VersionedMap`.
*
* [1]: Mutations at different versions may be adjacent. This is necessary for