blob: ae20ef126ed0c1426618ac6a49eb7592efbc0051 [file] [log] [blame]
<!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 `fixed` mod in crate `arrow_row`."><title>arrow_row::fixed - 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_row" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (8c127df75 2024-05-16)" data-channel="nightly" data-search-js="search-d52510db62a78183.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_row/index.html">arrow_row</a><span class="version">51.0.0</span></h2></div><h2 class="location"><a href="#">Module fixed</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#macros">Macros</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate arrow_row</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_row</a>::<wbr><a class="mod" href="#">fixed</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_row/fixed.rs.html#18-386">source</a> ยท <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">ยง</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.encode_signed.html" title="macro arrow_row::fixed::encode_signed">encode_signed</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div></li><li><div class="item-name"><a class="macro" href="macro.encode_unsigned.html" title="macro arrow_row::fixed::encode_unsigned">encode_unsigned</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">ยง</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.FixedLengthEncoding.html" title="trait arrow_row::fixed::FixedLengthEncoding">FixedLengthEncoding</a></div><div class="desc docblock-short">Encodes a value of a particular fixed width type into bytes according to the rules
described on <a href="../struct.RowConverter.html" title="struct arrow_row::RowConverter"><code>super::RowConverter</code></a></div></li><li><div class="item-name"><a class="trait" href="trait.FromSlice.html" title="trait arrow_row::fixed::FromSlice">FromSlice</a></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.decode_bool.html" title="fn arrow_row::fixed::decode_bool">decode_bool</a></div><div class="desc docblock-short">Decodes a <code>BooleanArray</code> from rows</div></li><li><div class="item-name"><a class="fn" href="fn.decode_fixed.html" title="fn arrow_row::fixed::decode_fixed">decode_fixed</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> <sup title="unsafe function">โš </sup></div><div class="desc docblock-short">Decodes a <code>ArrayData</code> from rows based on the provided <code>FixedLengthEncoding</code> <code>T</code></div></li><li><div class="item-name"><a class="fn" href="fn.decode_fixed_size_binary.html" title="fn arrow_row::fixed::decode_fixed_size_binary">decode_fixed_size_binary</a></div><div class="desc docblock-short">Decodes a <code>FixedLengthBinary</code> from rows</div></li><li><div class="item-name"><a class="fn" href="fn.decode_nulls.html" title="fn arrow_row::fixed::decode_nulls">decode_nulls</a></div><div class="desc docblock-short">Decodes a single byte from each row, interpreting <code>0x01</code> as a valid value
and all other values as a null</div></li><li><div class="item-name"><a class="fn" href="fn.decode_primitive.html" title="fn arrow_row::fixed::decode_primitive">decode_primitive</a></div><div class="desc docblock-short">Decodes a <code>PrimitiveArray</code> from rows</div></li><li><div class="item-name"><a class="fn" href="fn.encode.html" title="fn arrow_row::fixed::encode">encode</a></div><div class="desc docblock-short">Fixed width types are encoded as</div></li><li><div class="item-name"><a class="fn" href="fn.encode_fixed_size_binary.html" title="fn arrow_row::fixed::encode_fixed_size_binary">encode_fixed_size_binary</a></div></li><li><div class="item-name"><a class="fn" href="fn.encoded_len.html" title="fn arrow_row::fixed::encoded_len">encoded_len</a></div><div class="desc docblock-short">Returns the total encoded length (including null byte) for a value of type <code>T::Native</code></div></li><li><div class="item-name"><a class="fn" href="fn.split_off.html" title="fn arrow_row::fixed::split_off">split_off</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div><div class="desc docblock-short">Splits <code>len</code> bytes from <code>src</code></div></li></ul></section></div></main></body></html>