`flow.record.adapter.stream`¶

Module Contents¶

Classes¶

`StreamWriter`
`StreamReader`

Attributes¶

flow.record.adapter.stream.__usage__ = Multiline-String¶

Show Value

"""
Binary stream adapter (default adapter if none are specified)
---
Write usage: rdump -w stream://[PATH]
Read usage: rdump stream://[PATH]
[PATH]: path to file. Leave empty or "-" to output to stdout
"""

class flow.record.adapter.stream.StreamWriter(path: str, clobber=True, **kwargs)¶

Bases: flow.record.adapter.AbstractWriter

fp¶

stream¶

write(record: flow.record.Record) → None¶: Write a record.

flush() → None¶: Flush any buffered writes.

close() → None¶: Close the Writer, no more writes will be possible.

class flow.record.adapter.stream.StreamReader(path: str, selector: str | flow.record.selector.Selector = None, **kwargs)¶

Bases: flow.record.adapter.AbstractReader

fp¶

stream¶

__iter__() → Iterator[flow.record.Record]¶: Return a record iterator.

close() → None¶: Close the Reader, can be overriden to properly free resources.