struct IReadable

Declaration

struct IReadable { /* full declaration omitted */ };

Description

An abstract interface for reading MCAP data.

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

Method Overview

• public virtual uint64_t read(std::byte ** output, uint64_t offset, uint64_t size)
• public virtual uint64_t size() const
• public virtual ~IReadable()

Methods

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

Description

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

Parameters

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.

Returns

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.

¶virtual uint64_t size() const

Description

Returns the size of the file in bytes.

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

Returns

uint64_t The total number of bytes in the MCAP file.

¶virtual ~IReadable()

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