API cleanup: Move bt_iter_create/destroy to internal header

[babeltrace.git] / include / babeltrace / iterator-internal.h

diff --git a/include/babeltrace/iterator-internal.h b/include/babeltrace/iterator-internal.h
index 626a7a0009b16377406bc4e51d99425e6eda4e7e..ea47745a723c9b1a84d82942daa8434885be9917 100644 (file)
--- a/include/babeltrace/iterator-internal.h
+++ b/include/babeltrace/iterator-internal.h
@@ -33,6 +33,27 @@ struct bt_iter {
        struct bt_iter_pos *end_pos;
 };
 
        struct bt_iter_pos *end_pos;
 };
 

+/*
+ * bt_iter_create - Allocate a trace collection iterator.
+ *
+ * begin_pos and end_pos are optional parameters to specify the position
+ * at which the trace collection should be seeked upon iterator
+ * creation, and the position at which iteration will start returning
+ * "EOF".
+ *
+ * By default, if begin_pos is NULL, a BT_SEEK_CUR is performed at
+ * creation. By default, if end_pos is NULL, a BT_SEEK_END (end of
+ * trace) is the EOF criterion.
+ */
+struct bt_iter *bt_iter_create(struct bt_context *ctx,
+               struct bt_iter_pos *begin_pos,
+               struct bt_iter_pos *end_pos);
+
+/*
+ * bt_iter_destroy - Free a trace collection iterator.
+ */
+void bt_iter_destroy(struct bt_iter *iter);
+

 int bt_iter_init(struct bt_iter *iter,
                struct bt_context *ctx,
                struct bt_iter_pos *begin_pos,
 int bt_iter_init(struct bt_iter *iter,
                struct bt_context *ctx,
                struct bt_iter_pos *begin_pos,