class StreamWriter

Declaration

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

Description

Implements the IWritable interface used by McapWriter by wrapping a std::ostream stream.

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

Inherits from: IWritable

Member Variables

Inherited from IWritable:

public crcEnabled = false

Method Overview

• public StreamWriter(std::ostream & stream)
• public void end()
• public void flush()
• public void handleWrite(const std::byte * data, uint64_t size)
• public uint64_t size() const

Inherited from IWritable:

• public crc
• public end
• public flush
• protected handleWrite
• public resetCrc
• public size
• public write

Methods

¶StreamWriter(std::ostream& stream)

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

Parameters

std::ostream& stream

¶void end()

Description

Called when the writer is finished writing data to the output MCAP file.

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

¶void flush()

Description

flushes any buffered data to the output. This is called by McapWriter after every completed chunk. Callers may also retain a reference to the writer and call flush() at their own cadence. Defaults to a no-op.

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

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

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

Parameters

const std::byte* data

uint64_t size

¶uint64_t size() const

Description

Returns the current size of the file in bytes. This must be equal to the sum of all `size` parameters passed to `write()`.

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