exported type fix

Author: SimonUnge

src/osiris_log.erl

@@ -351,6 +351,7 @@
 -type offset_entry() :: {offset(), osiris:entry()}.
 -type offset_spec() :: osiris:offset_spec().
 -type retention_spec() :: osiris:retention_spec().
+-type chunk_iterator() :: osiris_log_read:chunk_iterator().
 -type header_map() ::
     #{chunk_id => offset(),
       epoch => epoch(),
@@ -758,15 +759,6 @@ counters_ref(#?MODULE{cfg = #cfg{counter = C}}) ->
 read_header(State) ->
     osiris_log_read:read_header(State).
 
--record(iterator, {fd :: file:io_device(),
-                   next_offset :: offset(),
-                   %% entries left
-                   num_left :: non_neg_integer(),
-                   %% any trailing data from last read
-                   %% we try to capture at least the size of the next record
-                   data :: undefined | binary(),
-                   next_record_pos :: non_neg_integer()}).
--opaque chunk_iterator() :: #iterator{}.
 -define(REC_MATCH_SIMPLE(Len, Rem),
         <<0:1, Len:31/unsigned, Rem/binary>>).
 -define(REC_MATCH_SUBBATCH(CompType, NumRec, UncompLen, Len, Rem),
@@ -781,21 +773,21 @@ read_header(State) ->
 
 
 -spec chunk_iterator(state()) ->
-    {ok, header_map(), chunk_iterator(), state()} |
+    {ok, header_map(), osiris_log_read:chunk_iterator(), state()} |
     {end_of_stream, state()} |
     {error, {invalid_chunk_header, term()}}.
 chunk_iterator(State) ->
     chunk_iterator(State, 1).
 
 -spec chunk_iterator(state(), pos_integer() | all) ->
-    {ok, header_map(), chunk_iterator(), state()} |
+    {ok, header_map(), osiris_log_read:chunk_iterator(), state()} |
     {end_of_stream, state()} |
     {error, {invalid_chunk_header, term()}}.
 chunk_iterator(State, CreditHint) ->
     osiris_log_read:chunk_iterator(State, CreditHint).
 
--spec iterator_next(chunk_iterator()) ->
-    end_of_chunk | {offset_entry(), chunk_iterator()}.
+-spec iterator_next(osiris_log_read:chunk_iterator()) ->
+    end_of_chunk | {offset_entry(), osiris_log_read:chunk_iterator()}.
 iterator_next(Iter) ->
     osiris_log_read:iterator_next(Iter).
 

src/osiris_log_read.erl

@@ -405,6 +405,7 @@ chunk_id_range_from_idx_files(FstIdxFile, LstIdxFile) ->
 
 chunk_location_for_timestamp(Idx, Ts) ->
     %% TODO: optimise using skip search approach
+    %%TODO GEN_IO SOLUTION
     Fd = open_index_read(Idx),
     %% scan index file for nearest timestamp
     {ChunkId, _Timestamp, _Epoch, FilePos} = timestamp_idx_scan(Fd, Ts),
@@ -579,6 +580,8 @@ build_seg_info(IdxFile) ->
 build_segment_info(SegFile, LastChunkPos, IdxFile) ->
     {ok, Fd} = osiris_log:open(SegFile, [read, binary, raw]),
     %% we don't want to read blocks into page cache we are unlikely to need
+
+    %%TODO GEN_IO SOLUTION
     _ = file:advise(Fd, 0, 0, random),
     case file:pread(Fd, ?LOG_HEADER_SIZE, ?HEADER_SIZE_B) of
         eof ->
@@ -1128,6 +1131,7 @@ truncate_to(_Name, _Range, [], IdxFiles) ->
     [begin ok = delete_segment_from_index(I) end || I <- IdxFiles],
     [];
 truncate_to(Name, RemoteRange, [{E, ChId} | NextEOs], IdxFiles) ->
+    %%TODO GEN_IO SOLUTION
     case find_segment_for_offset(ChId, IdxFiles) of
         {Result, _} when Result == not_found orelse
                          Result == end_of_log ->