NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
crates.io
crates.io, #3372 most downloaded on crates.io
A library for reading and writing MCAP files
Latest stable
0.26.0
Last release 1 months ago
19 Oct 2026
Release timing varies
gaps range from 2 weeks to 6 months
Some releases are documented
notes for 17 of 36 stable releases
2 versions withdrawn
withdrawn after publishing
4 years old
38 releases · first in 2022
Drag across the ruler to compare, or tap a release to open it.
log_time_on_or_after and log_time_before are deprecated aliases.
mcap::io::MessageReader reads linked Messages from any std::io::Read, built on the new sans_io::MessageReader. It detects truncated files by checking the end magic. (#1854, #1861)sans_io::decompressor::Decompressor and register it with add_decompressor on sans_io::LinearReader, sans_io::IndexedReader, both MessageReaders, and tokio::LinearReader. Registering a built-in name (lz4, zstd) replaces that decoder. (#1870, #1873)read::ChannelAccumulator is public, with add_schema, add_schema_from_slice, add_channel, get, channels(), and from_summary. (#1854, #1869)IndexedReaderOptions::starting_at, starting_after, ending_at, and ending_before state whether each bound is inclusive, with start()/end() accessors. log_time_on_or_after and log_time_before are deprecated aliases. (#1805)McapError gains EndBeforeStart and EmptyDecompressorName. Exhaustive matches need new arms. (#1805, #1870)MessageStream no longer fails when the summary's schema and channel records disagree with the data section, which happens validly after a repair, and no longer validates chunk CRCs by default. (#1861)IndexedReaderOptions with an end bound before the start bound now returns EndBeforeStart instead of an empty result. (#1805)DecompressionError instead of panicking when a chunk's decompressed size does not match the declared uncompressed size. (#1820, #1824)start_chunk, start_attachment, or finish_attachment, and never panics from Drop. (#1876)IndexedReader, about 20% faster on files with many small chunks. (#1850)Your coding agent can read these notes before it upgrades. Set up the MCP server →
Writer::add_schema_with_id and Writer::add_channel_with_id for writing records with explicit IDs without content de-duplication, so distinct IDs from
Writer::add_schema_with_id and Writer::add_channel_with_id for writing records with explicit IDs without content de-duplication, so distinct IDs from a source file are preserved even when content is identical (#1632).mcap::VERSION and mcap::LIBRARY_IDENTIFIER constants (#1702).WriteOptions::DEFAULT_CHUNK_SIZE constant.Header.library string is now mcap-rust/<version> (was mcap-rs-<version>) (#1702). Breaking for anyone asserting on the exact string.rust-version = "1.81") (#1710).binrw 0.12 → 0.15, thiserror 1 → 2 (#1705, #1710).McapError variants AttachmentInProgress, RecordTooShort, and UnexpectedChunkRecord (#1494). Breaking for code matching on these variants.McapError messages (e.g. expeted → expected, mulitple → multiple) — note these are user-visible error string changes (#1492).ChunkIndex::compressed_data_offset now correctly documenting BadChunkStartOffset (#1607, #1516).Support large files in FileReader on Windows by @Muon in https://github.com/foxglove/mcap/pull/1490
FileReader on Windows by @Muon in https://github.com/foxglove/mcap/pull/1490Full Changelog: https://github.com/foxglove/mcap/compare/releases/rust/v0.23.4...releases/rust/v0.24.0
rust: fix int underflow when chunk wasn't closed by @bennetthardwick in https://github.com/foxglove/mcap/pull/1480
Nothing published for this version
rust: Use buffer size as record length limit by @gasmith in https://github.com/foxglove/mcap/pull/1427
rust: Validate magic before footer opcode by @gasmith in https://github.com/foxglove/mcap/pull/1415
rust: Add option to summary reader to declare file size by @gasmith in https://github.com/foxglove/mcap/pull/1410
Nothing published for this version
rust: support writing private records by @bennetthardwick in https://github.com/foxglove/mcap/pull/1401
Nothing published for this version
Nothing published for this version
chore(rust): delete unused time conversion utilities by @alokpr in https://github.com/foxglove/mcap/pull/1391
Nothing published for this version
Nothing published for this version
The LinearReader in the sans_io module had multiple breaking changes in #1341. To fix:
The LinearReader in the sans_io module had multiple breaking changes in #1341. To fix:
mcap::sans_io::read to mcap::sans_io::linear_reader.mcap::sans_io::read::ReadAction to mcap::sans_io::linear_reader::LinearReadEventLinearReader::next_action() to LinearReader::next_event()LinearReader::set_written() to LinearReader::notify_read()mcap::tokio::read::RecordReader to mcap::tokio::linear_reader::LinearReadermemmap with memmap2 by @eric-seppanen in https://github.com/foxglove/mcap/pull/1350Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
rust: Make RawMessage fields public by @A-K-O-R-A in https://github.com/foxglove/mcap/pull/1184
Writer.add_metadata() and Writer.add_attachment() pass through to the underlying MCAP writer.
Nothing published for this version
Update the Writer tracking of message bounds to include log_time 0 as a valid time for bounds.
Update the Writer tracking of message bounds to include log_time 0 as a valid time for bounds.
Writer accepts a profile argument, since there is no well-known protobuf profile.
Nothing published for this version
mcap cat --format=ndjson prints one JSON object per message. --json still works but is deprecated and prints a warning.
mcap cat --format=ndjson prints one JSON object per message. --json still works but is deprecated and prints a warning. (#1779)mcap cat --format=csv --topics <TOPIC> exports one topic to CSV. Nested fields use dot notation and array elements use a numeric suffix. Columns that the header cannot hold are dropped with a warning and exit status 3. (#1781, #1786)--time-format flag (auto, rfc3339, seconds, nanoseconds) for cat, info, list chunks, and list attachments. (#1782)
cat (text), list chunks, and list attachments now show human-readable dates instead of raw nanoseconds. info no longer appends decimal seconds. Pass --time-format=nanoseconds for integer output.cat --format=ndjson emits log_time/publish_time as quoted strings (RFC 3339 by default), never as bare numbers.~/.aws/credentials, AWS_PROFILE, SSO, and credential_process work again. (#1826)mcap cat rejects a time range whose end is before its start on both the indexed and linear paths. (#1805)cat and filter use the crate's schema/channel linking. They reject schema ID 0, conflicting schema redefinitions, channels whose schema never appears, and channels defined before their schema. (#1869)compress, decompress, and filter no longer hash the full schema and channel for every message. On files with large schemas, compress was about 10x slower in 0.3.0. (#1887)Full Changelog: releases/mcap-cli/v0.3.0...releases/mcap-cli/v0.4.0
The old --include-metadata / --include-attachments flags are now hidden deprecated no-ops that warn on stderr.
mcap filter is now lossless by default: metadata and attachments are kept unless you pass the new --exclude-metadata / --exclude-attachments flags. The old --include-metadata / --include-attachments flags are now hidden deprecated no-ops that warn on stderr. (#1756)mcap filter --start / --end now apply to messages only; attachments are no longer dropped when their log_time falls outside the window (use --exclude-attachments to drop them). (#1756)mcap filter, mcap compress, and mcap decompress no longer silently re-sort indexed inputs: an out-of-order indexed file was previously re-sorted to log time, but the default is now --order preserve (keep stored message order). Pass --order log_time to restore the previous behavior. (#1762)filter, compress, decompress, sort) now write records in a standardized physical layout (metadata after the header → messages → attachments before Data End), so byte-level output can differ from 0.2.0 even when logical content is unchanged. (#1756, #1757)--order <preserve|log_time|topic> flag on filter, compress, decompress, and sort. preserve keeps stored order, log_time sorts by ascending log time (log-time alias), and topic groups each channel's messages together (channels by topic name then channel ID), placing each channel in its own chunk(s) when chunking is enabled for contiguous single-topic reads. Note that topic always buffers the selected messages in memory, and log_time buffers them when the input has no summary. (#1762, #1754, #1757)mcap filter gains --exclude-metadata and --exclude-attachments to opt out of the new lossless default. (#1756)mcap filter gains --no-chunks (write records outside of chunks). (#1763)mcap filter, compress, and decompress gain --no-crc (disable all output CRC fields), matching convert/merge/sort. (#1763)mcap sort gains an overridable --order flag (defaults to log_time), and its input and output are now optional — it reads from stdin and writes to stdout when omitted. (#1757)--help text across commands (remote URL inputs and --allow-remote-scan, log-time semantics for time filters, corrected cat --json encoding names, attachment retrieval, and in-place add corruption warnings), and hid the deprecated --start-nsecs / --end-nsecs flags from help (they remain accepted). (#1774)mcap cat --json now emits protobuf fields set to their proto3 default value (e.g. 0, "", false, enum zero-variants) instead of omitting them from the output. (#1765)Statistics record disagrees with its chunk message indexes (or a message index can't be parsed); the engine falls back to a linear scan. (#1771)mcap compress --compression invalid values are now rejected at parse time (exit code 2, [possible values: zstd, lz4, none]) instead of failing at runtime. (#1767)These flags were renamed for consistency across the rewrite commands; the old names still work as hidden aliases that print a stderr warning, so existing invocations keep functioning.
mcap filter --output-compression renamed to --compression, matching sort and the other rewrite commands (which already used --compression); --compression wins if both are set. (#1761)mcap sort --output-file renamed to --output (-o is unchanged), matching the other rewrite commands — previously only sort and merge used --output-file. filter, compress, and decompress also accept the deprecated --output-file as a hidden alias for uniformity. (#1757)mcap merge --output-file renamed to --output (-o is unchanged), for the same cross-command consistency. (#1771)mcap list attachments, mcap list metadata, mcap get attachment, and mcap get metadata can read local MCAP files that omit summary/index records by sca
mcap list attachments, mcap list metadata, mcap get attachment, and mcap get metadata can read local MCAP files that omit summary/index records by scanning when needed. (#1723)mcap merge now guarantees log-time ordered output, using command-line file order and per-file input order as stable tie-breakers for equal timestamps. (#1730)mcap doctor now reports invalid Statistics channel counts that lack prior summary Channel records. (#1722)mcap info now reports numeric counts for files without a Statistics record instead of unknown when the data can be derived. (#1725)mcap doctor now treats spec-legal out-of-order top-level message times as warnings by default, while --strict-message-order still errors. (#1724)mcap --version instead of reporting unknown. (#1727)mcap doctor -v no longer emits the low-value Examining ... progress line on clean diagnostics. (#1731)kB, MB, GB), and throughput labels use /s. (#1733)merge, filter, sort, compress, and decompress; this is benchmark coverage rather than a runtime performance change. (#1732)Nothing published for this version
The mcap CLI has been rewritten in Rust. It is a drop-in replacement for the previous release (v0.0.x) with the same commands, a smaller binary, new r
The mcap CLI has been rewritten in Rust. It is a drop-in replacement for the
previous release (v0.0.x) with the same commands, a smaller binary, new remote
and read capabilities, and a number of other changes described below.
info,
list, single-record get) use the file index to fetch only the bytes they
need, with no full download..db3 conversion. mcap convert reads the message
definitions embedded in ROS 2 bags (Iron and later) — no sourced workspace or
--ament-prefix-path required.mcap cat now reads local files
that have no index by scanning them in file order, and mcap sort now sorts
unindexed files, instead of refusing them.cat, filter, compress, and decompress accept piped
(non-seekable) stdin, so producer | mcap filter -o out.mcap works.info, list, and cat
fall back to scanning the data section when the summary is absent or incomplete
(printing a summary section not available; full scan may be slow warning to
stderr), and resolve schemas/channels that are defined only inside chunks — the
previous CLI silently reported such files as empty.mcap doctor no longer crashes when examining files with malformed summary
records (a truncated or corrupt ChunkIndex, AttachmentIndex, Schema, Channel,
Message, Metadata, MetadataIndex, or Header record previously caused a
segmentation fault).mcap recover always produces a valid, readable output file. Recovery
previously could write internally inconsistent chunk indexes for some inputs.mcap filter topic-regex filtering behaves correctly.
Previously, when --include-topic-regex matched no channels (or
--exclude-topic-regex matched every channel), the resulting empty topic set
was treated as "no filter" and every message was silently passed through. Both
cases now produce an empty result, as expected.sort), or silently write a file containing none of the input's
messages (compress). The new CLI fails with a clear, actionable error
pointing to mcap recover.compress, decompress, and
filter. The previous CLI omitted attachments that weren't listed in an
attachment index; they are now preserved and indexed in the output.mcap du totals now add up to the file size. Each record's reported size
includes its on-disk framing (the 1-byte opcode + 8-byte length prefix), and
attachment records are now included in the table; previously both were omitted,
so the totals undercounted the file. Percentages are computed in double
precision, removing rounding artifacts in the last digits (e.g. 66.666667).mcap version subcommand — use mcap --version, which now reports both the
CLI and library versions (replacing mcap version --library).--config global flag (no $HOME/.mcap.yaml config file) — the flag was
never actually used; no command ever read a value from the config file.--pprof-profile global flag.convert --ament-prefix-path — ROS 2 .db3 conversion now uses embedded
message definitions.compress --unchunked — compressed output is always chunked by definition.recover --always-decode-chunk — chunks are now always decoded.mcap recover signals data loss through its exit code: 0 = full recovery,
3 = recovered but lossy/truncated, 1 = nothing recovered. Previously it exited
0 as long as recovery started, even when data was lost. It now defaults to
--compression preserve (was zstd) and always decodes and re-encodes every
chunk to guarantee valid output.mcap convert selects the input type by file extension (.bag for ROS 1,
.db3 for ROS 2) instead of inspecting file contents, so inputs must use a
recognized extension. To convert pre-Iron .db3 bags that have no embedded
message definitions, use ros2 bag convert first.sort and convert. Using the
same path for input and output previously truncated the input and lost data.--compression values are now rejected everywhere instead of being
silently accepted.mcap add metadata rejects duplicate --key names instead of silently
keeping the last value, and now allows = inside values (e.g. -k key=a=b).mcap completion <shell> now also supports elvish (in addition to bash,
zsh, fish, and powershell), and rejects an unknown shell name with a usage
error instead of printing help.mcap doctor reports every structural problem it finds and writes all
diagnostics to stderr (previously it stopped at the first error and wrote some
warnings to stdout).2 (the conventional code) and errors
are prefixed with Error: on stderr.--include-crc → --no-crc and --chunked →
--no-chunks on convert, merge, and sort (effective defaults unchanged).--color {auto,always,never}, -v/--verbose
(repeatable), and --allow-remote-scan.--allow-remote-scan. Indexed reads
(info, list, single-record get) need no flag, but commands that read or
download the whole file (filter, merge, convert, recover, or any
linear-scan fallback) require it. With multiple remote inputs, each is
downloaded independently, so peak temporary disk usage can approach the combined
input size.Header.library = mcap-cli/<version> mcap-rust/<version>) for compress,
decompress, filter, sort, recover, merge, and convert, and no longer
carry forward the source file's library value. mcap add leaves the original
header untouched.mcap info now sorts compression lines, renders wall-clock start/end times
in UTC, and shows absolute RFC3339 timestamps only for recordings dated
2000-01-01 or later (older/relative timestamps render as decimal seconds).One column per quarter.