class IChunkWriter

Declaration

class IChunkWriter : public IWritable { /* full declaration omitted */ };

Description

An abstract interface for writing Chunk data. Chunk data is buffered in memory and written to disk as a single record, to support optimal compression and calculating the final Chunk data size.

Declared at: mcap/include/mcap/writer.hpp:206

Inherits from: IWritable

Member Variables

Inherited from IWritable:

public crcEnabled = false

Method Overview

Inherited from IWritable:

Methods

void clear()

Description

Clear the internal state of the writer, discarding any input or output buffers.

Declared at: mcap/include/mcap/writer.hpp:235

virtual const std::byte* compressedData() const

Description

Returns a pointer to the compressed data. This will only be called after `end()`.

Declared at: mcap/include/mcap/writer.hpp:244

virtual uint64_t compressedSize() const

Description

Returns the size in bytes of the compressed data. This will only be called after `end()`.

Declared at: mcap/include/mcap/writer.hpp:225

virtual const std::byte* data() const

Description

Returns a pointer to the uncompressed data.

Declared at: mcap/include/mcap/writer.hpp:239

virtual bool empty() const

Description

Returns true if `write()` has never been called since initialization or the last call to `clear()`.

Declared at: mcap/include/mcap/writer.hpp:230

virtual void end()

Description

Called when the writer wants to close the current output Chunk. After this call, `data()` and `size()` should return the data and size of the compressed data.

Declared at: mcap/include/mcap/writer.hpp:215

virtual void handleClear()

Declared at: mcap/include/mcap/writer.hpp:247

virtual uint64_t size() const

Description

Returns the size in bytes of the uncompressed data.

Declared at: mcap/include/mcap/writer.hpp:219

virtual ~IChunkWriter()

Declared at: mcap/include/mcap/writer.hpp:208