class ZStdWriter

Declaration

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

Description

An in-memory IChunkWriter implementation that holds data in a temporary buffer before flushing to an ZStandard-compressed buffer.

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

Inherits from: IChunkWriter

Member Variables

Inherited from IWritable:

public crcEnabled = false

Method Overview

Inherited from IChunkWriter:

Inherited from IWritable:

Methods

ZStdWriter(
    mcap::CompressionLevel compressionLevel,
    uint64_t chunkSize)

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

Parameters

mcap::CompressionLevel compressionLevel
uint64_t chunkSize

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:298

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:294

const std::byte* data() const

Description

Returns a pointer to the uncompressed data.

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

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:295

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:292

void handleClear()

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

void handleWrite(const std::byte* data,
                 uint64_t size)

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

Parameters

const std::byte* data
uint64_t size

uint64_t size() const

Description

Returns the size in bytes of the uncompressed data.

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

~ZStdWriter()

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