lib-index: mail_cache_lookup_iter_next() - Add a warning comment about re-reading...

diff --git a/src/lib-index/mail-cache-private.h b/src/lib-index/mail-cache-private.h
index 156a1a53b7edf23cdfb384473d1f901b82ecfedf..4871c9bbb867f64bf45173f3614d84d6fd769394 100644 (file)
--- a/src/lib-index/mail-cache-private.h
+++ b/src/lib-index/mail-cache-private.h
@@ -362,7 +362,8 @@ bool mail_cache_track_loops(struct mail_cache_loop_track *loop_track,
 /* Iterate through a message's cached fields. */
 void mail_cache_lookup_iter_init(struct mail_cache_view *view, uint32_t seq,
                                 struct mail_cache_lookup_iterate_ctx *ctx_r);
-/* Returns 1 if field was returned, 0 if end of fields, or -1 if error */
+/* Returns 1 if field was returned, 0 if end of fields, or -1 if error.
+   Note that this may trigger re-reading and reallocating cache fields. */
 int mail_cache_lookup_iter_next(struct mail_cache_lookup_iterate_ctx *ctx,
                                struct mail_cache_iterate_field *field_r);
 const struct mail_cache_record *