Skip to content

Commit 18241ac

Browse files
author
j-c-cook
committed
Add note to BLFWriter
1 parent 6f6c325 commit 18241ac

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

can/io/blf.py

+7
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,13 @@ def _parse_data(self, data):
359359
class BLFWriter(FileIOMessageWriter):
360360
"""
361361
Logs CAN data to a Binary Logging File compatible with Vector's tools.
362+
363+
.. note::
364+
The `buffer_size` will always stay under the `max_container_size`, which
365+
is enforced at the end of the `_add_object` function. If the
366+
`max_container_size > :attr:io.logger.RotatingLogger.max_bytes` then
367+
the resulting file size will be less than described due to an
368+
unaccounted compression of the buffer when writing to the file.
362369
"""
363370

364371
file: BinaryIO

0 commit comments

Comments
 (0)