class BufferReader

Declaration

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

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(int ** output, uint64_t offset, uint64_t size)
• public void reset(const int * data, uint64_t size, uint64_t uncompressedSize)
• public uint64_t size() const
• public mcap::Status status() const

Inherited from ICompressedReader:

• public reset
• public status

Inherited from IReadable:

• public read
• public size

Methods

¶BufferReader()

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

¶BufferReader(const mcap::BufferReader&)

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

Parameters

const mcap::BufferReader&

¶BufferReader(mcap::BufferReader&&)

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

Parameters

mcap::BufferReader&&

¶uint64_t read(int** output,
              uint64_t offset,
              uint64_t size)

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

Parameters

int** output

uint64_t offset

uint64_t size

¶void reset(const int* data,
           uint64_t size,
           uint64_t uncompressedSize)

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

Parameters

const int* data

uint64_t size

uint64_t uncompressedSize

¶uint64_t size() const

Description

Returns the size of the file in bytes.

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

Returns

uint64_t The total number of bytes in the MCAP file.

¶mcap::Status status() const

Description

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