| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `Message` mod in crate `arrow_ipc`."><title>arrow_ipc::gen::Message - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="arrow_ipc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0-nightly (d7f6ebace 2024-06-16)" data-channel="nightly" data-search-js="search-0fe7219eb170c82e.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../arrow_ipc/index.html">arrow_ipc</a><span class="version">52.0.0</span></h2></div><h2 class="location"><a href="#">Module Message</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In arrow_ipc::gen</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">arrow_ipc</a>::<wbr><a href="../index.html">gen</a>::<wbr><a class="mod" href="#">Message</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../src/arrow_ipc/gen/Message.rs.html#18-1490">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.BodyCompression.html" title="struct arrow_ipc::gen::Message::BodyCompression">BodyCompression</a></div><div class="desc docblock-short">Optional compression for the memory buffers constituting IPC message |
| bodies. Intended for use with RecordBatch but could be used for other |
| message types</div></li><li><div class="item-name"><a class="struct" href="struct.BodyCompressionArgs.html" title="struct arrow_ipc::gen::Message::BodyCompressionArgs">BodyCompressionArgs</a></div></li><li><div class="item-name"><a class="struct" href="struct.BodyCompressionBuilder.html" title="struct arrow_ipc::gen::Message::BodyCompressionBuilder">BodyCompressionBuilder</a></div></li><li><div class="item-name"><a class="struct" href="struct.BodyCompressionMethod.html" title="struct arrow_ipc::gen::Message::BodyCompressionMethod">BodyCompressionMethod</a></div><div class="desc docblock-short">Provided for forward compatibility in case we need to support different |
| strategies for compressing the IPC message body (like whole-body |
| compression rather than buffer-level) in the future</div></li><li><div class="item-name"><a class="struct" href="struct.CompressionType.html" title="struct arrow_ipc::gen::Message::CompressionType">CompressionType</a></div></li><li><div class="item-name"><a class="struct" href="struct.DictionaryBatch.html" title="struct arrow_ipc::gen::Message::DictionaryBatch">DictionaryBatch</a></div><div class="desc docblock-short">For sending dictionary encoding information. Any Field can be |
| dictionary-encoded, but in this case none of its children may be |
| dictionary-encoded. |
| There is one vector / column per dictionary, but that vector / column |
| may be spread across multiple dictionary batches by using the isDelta |
| flag</div></li><li><div class="item-name"><a class="struct" href="struct.DictionaryBatchArgs.html" title="struct arrow_ipc::gen::Message::DictionaryBatchArgs">DictionaryBatchArgs</a></div></li><li><div class="item-name"><a class="struct" href="struct.DictionaryBatchBuilder.html" title="struct arrow_ipc::gen::Message::DictionaryBatchBuilder">DictionaryBatchBuilder</a></div></li><li><div class="item-name"><a class="struct" href="struct.FieldNode.html" title="struct arrow_ipc::gen::Message::FieldNode">FieldNode</a></div><div class="desc docblock-short"><hr /> |
| </div></li><li><div class="item-name"><a class="struct" href="struct.Message.html" title="struct arrow_ipc::gen::Message::Message">Message</a></div></li><li><div class="item-name"><a class="struct" href="struct.MessageArgs.html" title="struct arrow_ipc::gen::Message::MessageArgs">MessageArgs</a></div></li><li><div class="item-name"><a class="struct" href="struct.MessageBuilder.html" title="struct arrow_ipc::gen::Message::MessageBuilder">MessageBuilder</a></div></li><li><div class="item-name"><a class="struct" href="struct.MessageHeader.html" title="struct arrow_ipc::gen::Message::MessageHeader">MessageHeader</a></div><div class="desc docblock-short"><hr /> |
| </div></li><li><div class="item-name"><a class="struct" href="struct.MessageHeaderUnionTableOffset.html" title="struct arrow_ipc::gen::Message::MessageHeaderUnionTableOffset">MessageHeaderUnionTableOffset</a></div></li><li><div class="item-name"><a class="struct" href="struct.RecordBatch.html" title="struct arrow_ipc::gen::Message::RecordBatch">RecordBatch</a></div><div class="desc docblock-short">A data header describing the shared memory layout of a “record” or “row” |
| batch. Some systems call this a “row batch” internally and others a “record |
| batch”.</div></li><li><div class="item-name"><a class="struct" href="struct.RecordBatchArgs.html" title="struct arrow_ipc::gen::Message::RecordBatchArgs">RecordBatchArgs</a></div></li><li><div class="item-name"><a class="struct" href="struct.RecordBatchBuilder.html" title="struct arrow_ipc::gen::Message::RecordBatchBuilder">RecordBatchBuilder</a></div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.BodyCompressionOffset.html" title="enum arrow_ipc::gen::Message::BodyCompressionOffset">BodyCompressionOffset</a></div></li><li><div class="item-name"><a class="enum" href="enum.DictionaryBatchOffset.html" title="enum arrow_ipc::gen::Message::DictionaryBatchOffset">DictionaryBatchOffset</a></div></li><li><div class="item-name"><a class="enum" href="enum.MessageOffset.html" title="enum arrow_ipc::gen::Message::MessageOffset">MessageOffset</a></div></li><li><div class="item-name"><a class="enum" href="enum.RecordBatchOffset.html" title="enum arrow_ipc::gen::Message::RecordBatchOffset">RecordBatchOffset</a></div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.ENUM_MAX_BODY_COMPRESSION_METHOD.html" title="constant arrow_ipc::gen::Message::ENUM_MAX_BODY_COMPRESSION_METHOD">ENUM_MAX_BODY_COMPRESSION_METHOD</a><span class="stab deprecated" title="">Deprecated</span></div></li><li><div class="item-name"><a class="constant" href="constant.ENUM_MAX_COMPRESSION_TYPE.html" title="constant arrow_ipc::gen::Message::ENUM_MAX_COMPRESSION_TYPE">ENUM_MAX_COMPRESSION_TYPE</a><span class="stab deprecated" title="">Deprecated</span></div></li><li><div class="item-name"><a class="constant" href="constant.ENUM_MAX_MESSAGE_HEADER.html" title="constant arrow_ipc::gen::Message::ENUM_MAX_MESSAGE_HEADER">ENUM_MAX_MESSAGE_HEADER</a><span class="stab deprecated" title="">Deprecated</span></div></li><li><div class="item-name"><a class="constant" href="constant.ENUM_MIN_BODY_COMPRESSION_METHOD.html" title="constant arrow_ipc::gen::Message::ENUM_MIN_BODY_COMPRESSION_METHOD">ENUM_MIN_BODY_COMPRESSION_METHOD</a><span class="stab deprecated" title="">Deprecated</span></div></li><li><div class="item-name"><a class="constant" href="constant.ENUM_MIN_COMPRESSION_TYPE.html" title="constant arrow_ipc::gen::Message::ENUM_MIN_COMPRESSION_TYPE">ENUM_MIN_COMPRESSION_TYPE</a><span class="stab deprecated" title="">Deprecated</span></div></li><li><div class="item-name"><a class="constant" href="constant.ENUM_MIN_MESSAGE_HEADER.html" title="constant arrow_ipc::gen::Message::ENUM_MIN_MESSAGE_HEADER">ENUM_MIN_MESSAGE_HEADER</a><span class="stab deprecated" title="">Deprecated</span></div></li><li><div class="item-name"><a class="constant" href="constant.ENUM_VALUES_BODY_COMPRESSION_METHOD.html" title="constant arrow_ipc::gen::Message::ENUM_VALUES_BODY_COMPRESSION_METHOD">ENUM_VALUES_BODY_COMPRESSION_METHOD</a><span class="stab deprecated" title="">Deprecated</span></div></li><li><div class="item-name"><a class="constant" href="constant.ENUM_VALUES_COMPRESSION_TYPE.html" title="constant arrow_ipc::gen::Message::ENUM_VALUES_COMPRESSION_TYPE">ENUM_VALUES_COMPRESSION_TYPE</a><span class="stab deprecated" title="">Deprecated</span></div></li><li><div class="item-name"><a class="constant" href="constant.ENUM_VALUES_MESSAGE_HEADER.html" title="constant arrow_ipc::gen::Message::ENUM_VALUES_MESSAGE_HEADER">ENUM_VALUES_MESSAGE_HEADER</a><span class="stab deprecated" title="">Deprecated</span></div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.finish_message_buffer.html" title="fn arrow_ipc::gen::Message::finish_message_buffer">finish_message_buffer</a></div></li><li><div class="item-name"><a class="fn" href="fn.finish_size_prefixed_message_buffer.html" title="fn arrow_ipc::gen::Message::finish_size_prefixed_message_buffer">finish_size_prefixed_message_buffer</a></div></li><li><div class="item-name"><a class="fn" href="fn.root_as_message.html" title="fn arrow_ipc::gen::Message::root_as_message">root_as_message</a></div><div class="desc docblock-short">Verifies that a buffer of bytes contains a <code>Message</code> |
| and returns it. |
| Note that verification is still experimental and may not |
| catch every error, or be maximally performant. For the |
| previous, unchecked, behavior use |
| <code>root_as_message_unchecked</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.root_as_message_unchecked.html" title="fn arrow_ipc::gen::Message::root_as_message_unchecked">root_as_message_unchecked</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Assumes, without verification, that a buffer of bytes contains a Message and returns it.</div></li><li><div class="item-name"><a class="fn" href="fn.root_as_message_with_opts.html" title="fn arrow_ipc::gen::Message::root_as_message_with_opts">root_as_message_with_opts</a></div><div class="desc docblock-short">Verifies, with the given options, that a buffer of bytes |
| contains a <code>Message</code> and returns it. |
| Note that verification is still experimental and may not |
| catch every error, or be maximally performant. For the |
| previous, unchecked, behavior use |
| <code>root_as_message_unchecked</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.size_prefixed_root_as_message.html" title="fn arrow_ipc::gen::Message::size_prefixed_root_as_message">size_prefixed_root_as_message</a></div><div class="desc docblock-short">Verifies that a buffer of bytes contains a size prefixed |
| <code>Message</code> and returns it. |
| Note that verification is still experimental and may not |
| catch every error, or be maximally performant. For the |
| previous, unchecked, behavior use |
| <code>size_prefixed_root_as_message_unchecked</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.size_prefixed_root_as_message_unchecked.html" title="fn arrow_ipc::gen::Message::size_prefixed_root_as_message_unchecked">size_prefixed_root_as_message_unchecked</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Assumes, without verification, that a buffer of bytes contains a size prefixed Message and returns it.</div></li><li><div class="item-name"><a class="fn" href="fn.size_prefixed_root_as_message_with_opts.html" title="fn arrow_ipc::gen::Message::size_prefixed_root_as_message_with_opts">size_prefixed_root_as_message_with_opts</a></div><div class="desc docblock-short">Verifies, with the given verifier options, that a buffer of |
| bytes contains a size prefixed <code>Message</code> and returns |
| it. Note that verification is still experimental and may not |
| catch every error, or be maximally performant. For the |
| previous, unchecked, behavior use |
| <code>root_as_message_unchecked</code>.</div></li></ul></section></div></main></body></html> |
