ir_datasets icon indicating copy to clipboard operation
ir_datasets copied to clipboard

what is a "`streamer`"

Open MangoIV opened this issue 2 years ago • 1 comments

It is not documented anywhere, what a streamer as used in classes like "RelativePath" is. It would be immensely helpful to have at least one tiny docstring explaining the use of this function.

MangoIV avatar May 01 '23 12:05 MangoIV

Good call -- I think that #103 (and corresponding WIP branch) should help with this, e.g., by adding base classes and such.

Basically, a streamer is an object that provides a stream() method that returns an iostream that can be opened with a context manager, read in sequence, and closed by the context manager.

seanmacavaney avatar May 01 '23 13:05 seanmacavaney