| <!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="Source of the Rust file `arrow-data/src/byte_view.rs`."><title>byte_view.rs - source</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_data" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0-nightly (6b0f4b5ec 2024-06-24)" 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="../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a> |
| <a href="#2" id="2">2</a> |
| <a href="#3" id="3">3</a> |
| <a href="#4" id="4">4</a> |
| <a href="#5" id="5">5</a> |
| <a href="#6" id="6">6</a> |
| <a href="#7" id="7">7</a> |
| <a href="#8" id="8">8</a> |
| <a href="#9" id="9">9</a> |
| <a href="#10" id="10">10</a> |
| <a href="#11" id="11">11</a> |
| <a href="#12" id="12">12</a> |
| <a href="#13" id="13">13</a> |
| <a href="#14" id="14">14</a> |
| <a href="#15" id="15">15</a> |
| <a href="#16" id="16">16</a> |
| <a href="#17" id="17">17</a> |
| <a href="#18" id="18">18</a> |
| <a href="#19" id="19">19</a> |
| <a href="#20" id="20">20</a> |
| <a href="#21" id="21">21</a> |
| <a href="#22" id="22">22</a> |
| <a href="#23" id="23">23</a> |
| <a href="#24" id="24">24</a> |
| <a href="#25" id="25">25</a> |
| <a href="#26" id="26">26</a> |
| <a href="#27" id="27">27</a> |
| <a href="#28" id="28">28</a> |
| <a href="#29" id="29">29</a> |
| <a href="#30" id="30">30</a> |
| <a href="#31" id="31">31</a> |
| <a href="#32" id="32">32</a> |
| <a href="#33" id="33">33</a> |
| <a href="#34" id="34">34</a> |
| <a href="#35" id="35">35</a> |
| <a href="#36" id="36">36</a> |
| <a href="#37" id="37">37</a> |
| <a href="#38" id="38">38</a> |
| <a href="#39" id="39">39</a> |
| <a href="#40" id="40">40</a> |
| <a href="#41" id="41">41</a> |
| <a href="#42" id="42">42</a> |
| <a href="#43" id="43">43</a> |
| <a href="#44" id="44">44</a> |
| <a href="#45" id="45">45</a> |
| <a href="#46" id="46">46</a> |
| <a href="#47" id="47">47</a> |
| <a href="#48" id="48">48</a> |
| <a href="#49" id="49">49</a> |
| <a href="#50" id="50">50</a> |
| <a href="#51" id="51">51</a> |
| <a href="#52" id="52">52</a> |
| <a href="#53" id="53">53</a> |
| <a href="#54" id="54">54</a> |
| <a href="#55" id="55">55</a> |
| <a href="#56" id="56">56</a> |
| <a href="#57" id="57">57</a> |
| <a href="#58" id="58">58</a> |
| <a href="#59" id="59">59</a> |
| <a href="#60" id="60">60</a> |
| <a href="#61" id="61">61</a> |
| <a href="#62" id="62">62</a> |
| <a href="#63" id="63">63</a> |
| <a href="#64" id="64">64</a> |
| <a href="#65" id="65">65</a> |
| <a href="#66" id="66">66</a> |
| <a href="#67" id="67">67</a> |
| <a href="#68" id="68">68</a> |
| <a href="#69" id="69">69</a> |
| <a href="#70" id="70">70</a> |
| <a href="#71" id="71">71</a> |
| <a href="#72" id="72">72</a> |
| <a href="#73" id="73">73</a> |
| <a href="#74" id="74">74</a> |
| <a href="#75" id="75">75</a> |
| <a href="#76" id="76">76</a> |
| <a href="#77" id="77">77</a> |
| <a href="#78" id="78">78</a> |
| <a href="#79" id="79">79</a> |
| <a href="#80" id="80">80</a> |
| <a href="#81" id="81">81</a> |
| <a href="#82" id="82">82</a> |
| <a href="#83" id="83">83</a> |
| <a href="#84" id="84">84</a> |
| <a href="#85" id="85">85</a> |
| <a href="#86" id="86">86</a> |
| <a href="#87" id="87">87</a> |
| <a href="#88" id="88">88</a> |
| <a href="#89" id="89">89</a> |
| <a href="#90" id="90">90</a> |
| <a href="#91" id="91">91</a> |
| <a href="#92" id="92">92</a> |
| <a href="#93" id="93">93</a> |
| <a href="#94" id="94">94</a> |
| <a href="#95" id="95">95</a> |
| <a href="#96" id="96">96</a> |
| <a href="#97" id="97">97</a> |
| <a href="#98" id="98">98</a> |
| <a href="#99" id="99">99</a> |
| <a href="#100" id="100">100</a> |
| <a href="#101" id="101">101</a> |
| <a href="#102" id="102">102</a> |
| <a href="#103" id="103">103</a> |
| <a href="#104" id="104">104</a> |
| <a href="#105" id="105">105</a> |
| <a href="#106" id="106">106</a> |
| <a href="#107" id="107">107</a> |
| <a href="#108" id="108">108</a> |
| <a href="#109" id="109">109</a> |
| <a href="#110" id="110">110</a> |
| <a href="#111" id="111">111</a> |
| <a href="#112" id="112">112</a> |
| <a href="#113" id="113">113</a> |
| <a href="#114" id="114">114</a> |
| <a href="#115" id="115">115</a> |
| <a href="#116" id="116">116</a> |
| <a href="#117" id="117">117</a> |
| <a href="#118" id="118">118</a> |
| <a href="#119" id="119">119</a> |
| <a href="#120" id="120">120</a> |
| <a href="#121" id="121">121</a> |
| <a href="#122" id="122">122</a> |
| <a href="#123" id="123">123</a> |
| </pre></div><pre class="rust"><code><span class="comment">// Licensed to the Apache Software Foundation (ASF) under one |
| // or more contributor license agreements. See the NOTICE file |
| // distributed with this work for additional information |
| // regarding copyright ownership. The ASF licenses this file |
| // to you under the Apache License, Version 2.0 (the |
| // "License"); you may not use this file except in compliance |
| // with the License. You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, |
| // software distributed under the License is distributed on an |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| // KIND, either express or implied. See the License for the |
| // specific language governing permissions and limitations |
| // under the License. |
| |
| </span><span class="kw">use </span>arrow_buffer::Buffer; |
| <span class="kw">use </span>arrow_schema::ArrowError; |
| |
| <span class="attr">#[derive(Debug, Copy, Clone, Default)] |
| #[repr(C)] |
| </span><span class="kw">pub struct </span>ByteView { |
| <span class="doccomment">/// The length of the string/bytes. |
| </span><span class="kw">pub </span>length: u32, |
| <span class="doccomment">/// First 4 bytes of string/bytes data. |
| </span><span class="kw">pub </span>prefix: u32, |
| <span class="doccomment">/// The buffer index. |
| </span><span class="kw">pub </span>buffer_index: u32, |
| <span class="doccomment">/// The offset into the buffer. |
| </span><span class="kw">pub </span>offset: u32, |
| } |
| |
| <span class="kw">impl </span>ByteView { |
| <span class="attr">#[inline(always)] |
| </span><span class="kw">pub fn </span>as_u128(<span class="self">self</span>) -> u128 { |
| (<span class="self">self</span>.length <span class="kw">as </span>u128) |
| | ((<span class="self">self</span>.prefix <span class="kw">as </span>u128) << <span class="number">32</span>) |
| | ((<span class="self">self</span>.buffer_index <span class="kw">as </span>u128) << <span class="number">64</span>) |
| | ((<span class="self">self</span>.offset <span class="kw">as </span>u128) << <span class="number">96</span>) |
| } |
| } |
| |
| <span class="kw">impl </span>From<u128> <span class="kw">for </span>ByteView { |
| <span class="attr">#[inline] |
| </span><span class="kw">fn </span>from(value: u128) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| length: value <span class="kw">as </span>u32, |
| prefix: (value >> <span class="number">32</span>) <span class="kw">as </span>u32, |
| buffer_index: (value >> <span class="number">64</span>) <span class="kw">as </span>u32, |
| offset: (value >> <span class="number">96</span>) <span class="kw">as </span>u32, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>From<ByteView> <span class="kw">for </span>u128 { |
| <span class="attr">#[inline] |
| </span><span class="kw">fn </span>from(value: ByteView) -> <span class="self">Self </span>{ |
| value.as_u128() |
| } |
| } |
| |
| <span class="doccomment">/// Validates the combination of `views` and `buffers` is a valid BinaryView |
| </span><span class="kw">pub fn </span>validate_binary_view(views: <span class="kw-2">&</span>[u128], buffers: <span class="kw-2">&</span>[Buffer]) -> <span class="prelude-ty">Result</span><(), ArrowError> { |
| validate_view_impl(views, buffers, |<span class="kw">_</span>, <span class="kw">_</span>| <span class="prelude-val">Ok</span>(())) |
| } |
| |
| <span class="doccomment">/// Validates the combination of `views` and `buffers` is a valid StringView |
| </span><span class="kw">pub fn </span>validate_string_view(views: <span class="kw-2">&</span>[u128], buffers: <span class="kw-2">&</span>[Buffer]) -> <span class="prelude-ty">Result</span><(), ArrowError> { |
| validate_view_impl(views, buffers, |idx, b| { |
| std::str::from_utf8(b).map_err(|e| { |
| ArrowError::InvalidArgumentError(<span class="macro">format!</span>( |
| <span class="string">"Encountered non-UTF-8 data at index {idx}: {e}" |
| </span>)) |
| })<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(()) |
| }) |
| } |
| |
| <span class="kw">fn </span>validate_view_impl<F>(views: <span class="kw-2">&</span>[u128], buffers: <span class="kw-2">&</span>[Buffer], f: F) -> <span class="prelude-ty">Result</span><(), ArrowError> |
| <span class="kw">where |
| </span>F: Fn(usize, <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><(), ArrowError>, |
| { |
| <span class="kw">for </span>(idx, v) <span class="kw">in </span>views.iter().enumerate() { |
| <span class="kw">let </span>len = <span class="kw-2">*</span>v <span class="kw">as </span>u32; |
| <span class="kw">if </span>len <= <span class="number">12 </span>{ |
| <span class="kw">if </span>len < <span class="number">12 </span>&& (v >> (<span class="number">32 </span>+ len * <span class="number">8</span>)) != <span class="number">0 </span>{ |
| <span class="kw">return </span><span class="prelude-val">Err</span>(ArrowError::InvalidArgumentError(<span class="macro">format!</span>( |
| <span class="string">"View at index {idx} contained non-zero padding for string of length {len}"</span>, |
| ))); |
| } |
| f(idx, <span class="kw-2">&</span>v.to_le_bytes()[<span class="number">4</span>..<span class="number">4 </span>+ len <span class="kw">as </span>usize])<span class="question-mark">?</span>; |
| } <span class="kw">else </span>{ |
| <span class="kw">let </span>view = ByteView::from(<span class="kw-2">*</span>v); |
| <span class="kw">let </span>data = buffers.get(view.buffer_index <span class="kw">as </span>usize).ok_or_else(|| { |
| ArrowError::InvalidArgumentError(<span class="macro">format!</span>( |
| <span class="string">"Invalid buffer index at {idx}: got index {} but only has {} buffers"</span>, |
| view.buffer_index, |
| buffers.len() |
| )) |
| })<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>start = view.offset <span class="kw">as </span>usize; |
| <span class="kw">let </span>end = start + len <span class="kw">as </span>usize; |
| <span class="kw">let </span>b = data.get(start..end).ok_or_else(|| { |
| ArrowError::InvalidArgumentError(<span class="macro">format!</span>( |
| <span class="string">"Invalid buffer slice at {idx}: got {start}..{end} but buffer {} has length {}"</span>, |
| view.buffer_index, |
| data.len() |
| )) |
| })<span class="question-mark">?</span>; |
| |
| <span class="kw">if </span>!b.starts_with(<span class="kw-2">&</span>view.prefix.to_le_bytes()) { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(ArrowError::InvalidArgumentError( |
| <span class="string">"Mismatch between embedded prefix and data"</span>.to_string(), |
| )); |
| } |
| |
| f(idx, b)<span class="question-mark">?</span>; |
| } |
| } |
| <span class="prelude-val">Ok</span>(()) |
| } |
| </code></pre></div></section></main></body></html> |
