class BufferReader


class BufferReader : public ICompressedReader { /* full declaration omitted */ };


A "null" compressed reader that directly passes through uncompressed data. No internal buffers are allocated.

Declared at: mcap/include/mcap/reader.hpp:135

Inherits from: ICompressedReader

Method Overview

  • public BufferReader()
  • public BufferReader(const mcap::BufferReader &)
  • public BufferReader(mcap::BufferReader &&)
  • public uint64_t read(std::byte ** output, uint64_t offset, uint64_t size)
  • public void reset(const std::byte * data, uint64_t size, uint64_t uncompressedSize)
  • public uint64_t size() const
  • public mcap::Status status() const

Inherited from ICompressedReader:

Inherited from IReadable:



Declared at: mcap/include/mcap/reader.hpp:142

BufferReader(const mcap::BufferReader&)

Declared at: mcap/include/mcap/reader.hpp:143


const mcap::BufferReader&


Declared at: mcap/include/mcap/reader.hpp:145



uint64_t read(std::byte** output,
              uint64_t offset,
              uint64_t size)


This method is called by MCAP reader classes when they need to read a portion of the file.

Declared at: mcap/include/mcap/reader.hpp:138


std::byte** output
A pointer to a pointer to the buffer to write to. This method is expected to either maintain an internal buffer, read data into it, and update this pointer to point at the internal buffer, or update this pointer to point directly at the source data if possible. The pointer and data must remain valid and unmodified until the next call to read().
uint64_t offset
The offset in bytes from the beginning of the file to read.
uint64_t size
The number of bytes to read.


uint64_t Number of bytes actually read. This may be less than the requested size if the end of the file is reached. The output pointer must be readable from `output` to `output + size`. If the read fails, this method should return 0.

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


Reset the reader state, clearing any internal buffers and state, and initialize with new compressed data.

Declared at: mcap/include/mcap/reader.hpp:137


const std::byte* data
Compressed data to read from.
uint64_t size
Size of the compressed data in bytes.
uint64_t uncompressedSize
Size of the data in bytes after decompression. A buffer of this size will be allocated for the uncompressed data.

uint64_t size() const


Returns the size of the file in bytes.

Declared at: mcap/include/mcap/reader.hpp:139


uint64_t The total number of bytes in the MCAP file.

mcap::Status status() const


Report the current status of decompression. A StatusCode other than `StatusCode::Success` after `reset()` is called indicates the decompression was not successful and the reader is in an invalid state.

Declared at: mcap/include/mcap/reader.hpp:140