|
| struct | Attachment |
| | An Attachment is an arbitrary file embedded in an MCAP file, including a name, media type, timestamps, and optional CRC. Attachment records are written in the Data section, outside of Chunks. More...
|
| |
| struct | AttachmentIndex |
| | Attachment Index records are found in the Summary section, providing summary information for a single Attachment. More...
|
| |
| class | BufferReader |
| | A "null" compressed reader that directly passes through uncompressed data. No internal buffers are allocated. More...
|
| |
| class | BufferWriter |
| | An in-memory IChunkWriter implementation backed by a growable buffer. More...
|
| |
| struct | Channel |
| | Describes a Channel that messages are written to. A Channel represents a single connection from a publisher to a topic, so each topic will have one Channel per publisher. Channels optionally reference a Schema, for message encodings that are not self-describing (e.g. JSON) or when schema information is available (e.g. JSONSchema). More...
|
| |
| struct | Chunk |
| | An collection of Schemas, Channels, and Messages that supports compression and indexing. More...
|
| |
| struct | ChunkIndex |
| | Chunk Index records are found in the Summary section, providing summary information for a single Chunk and pointing to each Message Index record associated with that Chunk. More...
|
| |
| struct | DataEnd |
| | The final record in the Data section, signaling the end of Data and beginning of Summary. Optionally contains a CRC of the entire Data section. More...
|
| |
| class | FileReader |
| | IReadable implementation wrapping a FILE* pointer created by fopen() and a read buffer. More...
|
| |
| class | FileStreamReader |
| | IReadable implementation wrapping a std::ifstream input file stream. More...
|
| |
| class | FileWriter |
| | Implements the IWritable interface used by McapWriter by wrapping a FILE* pointer created by fopen(). More...
|
| |
| struct | Footer |
| | The final record in an MCAP file (before the trailing magic byte sequence). Contains byte offsets from the start of the file to the Summary and Summary Offset sections, along with an optional CRC of the combined Summary and Summary Offset sections. A summaryStart and summaryOffsetStart of zero indicates no Summary section is available. More...
|
| |
| struct | Header |
| | Appears at the beginning of every MCAP file (after the magic byte sequence) and contains the recording profile (see https://github.com/foxglove/mcap/tree/main/docs/specification/profiles) and a string signature of the recording library. More...
|
| |
| class | IChunkWriter |
| | An abstract interface for writing Chunk data. Chunk data is buffered in memory and written to disk as a single record, to support optimal compression and calculating the final Chunk data size. More...
|
| |
| class | ICompressedReader |
| | An abstract interface for compressed readers. More...
|
| |
| struct | IndexedMessageReader |
| | Uses message indices to read messages out of an MCAP in log time order. The underlying MCAP must be chunked, with a summary section and message indexes. The required McapWriterOptions are: More...
|
| |
| struct | IReadable |
| | An abstract interface for reading MCAP data. More...
|
| |
| class | IWritable |
| | An abstract interface for writing MCAP data. More...
|
| |
| struct | LinearMessageView |
| | An iterable view of Messages in an MCAP file. More...
|
| |
| struct | LoadParams |
| |
| class | LZ4Reader |
| | ICompressedReader implementation that decompresses LZ4 (https://lz4.github.io/lz4/) data. More...
|
| |
| class | LZ4Writer |
| | An in-memory IChunkWriter implementation that holds data in a temporary buffer before flushing to an LZ4-compressed buffer. More...
|
| |
| class | McapReader |
| | Provides a read interface to an MCAP file. More...
|
| |
| class | McapWriter |
| | Provides a write interface to an MCAP file. More...
|
| |
| struct | McapWriterOptions |
| | Configuration options for McapWriter. More...
|
| |
| struct | Message |
| | A single Message published to a Channel. More...
|
| |
| struct | MessageIndex |
| | A list of timestamps to byte offsets for a single Channel. This record appears after each Chunk, one per Channel that appeared in that Chunk. More...
|
| |
| struct | MessageView |
| | Returned when iterating over Messages in a file, MessageView contains a reference to one Message, a pointer to its Channel, and an optional pointer to that Channel's Schema. The Channel pointer is guaranteed to be valid, while the Schema pointer may be null if the Channel references schema_id 0. More...
|
| |
| struct | Metadata |
| | Holds a named map of key/value strings containing arbitrary user data. Metadata records are found in the Data section, outside of Chunks. More...
|
| |
| struct | MetadataIndex |
| | Metadata Index records are found in the Summary section, providing summary information for a single Metadata record. More...
|
| |
| struct | ReadMessageOptions |
| | Options for reading messages out of an MCAP file. More...
|
| |
| struct | Record |
| | A generic Type-Length-Value record using a uint8 type and uint64 length. This is the generic form of all MCAP records. More...
|
| |
| struct | RecordOffset |
| |
| struct | RecordReader |
| | A low-level interface for parsing MCAP-style TLV records from a data source. More...
|
| |
| struct | Schema |
| | Describes a schema used for message encoding and decoding and/or describing the shape of messages. One or more Channel records map to a single Schema. More...
|
| |
| struct | Statistics |
| | The Statistics record is found in the Summary section, providing counts and timestamp ranges for the entire file. More...
|
| |
| struct | Status |
| | Wraps a status code and string message carrying additional context. More...
|
| |
| class | StreamWriter |
| | Implements the IWritable interface used by McapWriter by wrapping a std::ostream stream. More...
|
| |
| struct | SummaryOffset |
| | Summary Offset records are found in the Summary Offset section. Records in the Summary section are grouped together, and for each record type found in the Summary section, a Summary Offset references the file offset and length where that type of Summary record can be found. More...
|
| |
| struct | TypedChunkReader |
| |
| struct | TypedRecordReader |
| | A mid-level interface for parsing and validating MCAP records from a data source. More...
|
| |
| class | ZStdReader |
| | ICompressedReader implementation that decompresses Zstandard (https://facebook.github.io/zstd/) data. More...
|
| |
| class | ZStdWriter |
| | An in-memory IChunkWriter implementation that holds data in a temporary buffer before flushing to an ZStandard-compressed buffer. More...
|
| |