blob: 4859025120b94401f2287088445decb430180ca8 [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="A type that can be used within a variable-size array to encode offset information"><title>OffsetSizeTrait in arrow_array::array - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="arrow_array" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (6380899f3 2025-10-18)" data-channel="nightly" data-search-js="search-8d3311b9.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="icon" href="https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">OffsetSizeTrait</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../arrow_array/index.html"><img src="https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg" alt="logo"></a><h2><a href="../../arrow_array/index.html">arrow_<wbr>array</a><span class="version">57.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Offset<wbr>Size<wbr>Trait</a></h2><h3><a href="#required-associated-consts">Required Associated Constants</a></h3><ul class="block"><li><a href="#associatedconstant.IS_LARGE" title="IS_LARGE">IS_LARGE</a></li><li><a href="#associatedconstant.MAX_OFFSET" title="MAX_OFFSET">MAX_OFFSET</a></li><li><a href="#associatedconstant.PREFIX" title="PREFIX">PREFIX</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-OffsetSizeTrait-for-i32" title="i32">i32</a></li><li><a href="#impl-OffsetSizeTrait-for-i64" title="i64">i64</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In arrow_<wbr>array::<wbr>array</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">arrow_array</a>::<wbr><a href="index.html">array</a></div><h1>Trait <span class="trait">Offset<wbr>Size<wbr>Trait</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/arrow_array/array/list_array.rs.html#40-49">Source</a> </span></div><pre class="rust item-decl"><code>pub trait OffsetSizeTrait:
ArrowNativeType
+ <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.AddAssign.html" title="trait core::ops::arith::AddAssign">AddAssign</a>
+ <a class="trait" href="https://docs.rs/num-integer/0.1/num_integer/trait.Integer.html" title="trait num_integer::Integer">Integer</a>
+ <a class="trait" href="https://docs.rs/num-traits/0.2/num_traits/ops/checked/trait.CheckedAdd.html" title="trait num_traits::ops::checked::CheckedAdd">CheckedAdd</a> {
const <a href="#associatedconstant.IS_LARGE" class="constant">IS_LARGE</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
const <a href="#associatedconstant.PREFIX" class="constant">PREFIX</a>: &amp;'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>;
const <a href="#associatedconstant.MAX_OFFSET" class="constant">MAX_OFFSET</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A type that can be used within a variable-size array to encode offset information</p>
<p>See <a href="type.ListArray.html" title="type arrow_array::array::ListArray"><code>ListArray</code></a>, <a href="type.LargeListArray.html" title="type arrow_array::array::LargeListArray"><code>LargeListArray</code></a>, <a href="type.BinaryArray.html" title="type arrow_array::array::BinaryArray"><code>BinaryArray</code></a>, <a href="type.LargeBinaryArray.html" title="type arrow_array::array::LargeBinaryArray"><code>LargeBinaryArray</code></a>,
<a href="type.StringArray.html" title="type arrow_array::array::StringArray"><code>StringArray</code></a> and <a href="type.LargeStringArray.html" title="type arrow_array::array::LargeStringArray"><code>LargeStringArray</code></a></p>
</div></details><h2 id="required-associated-consts" class="section-header">Required Associated Constants<a href="#required-associated-consts" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedconstant.IS_LARGE" class="method"><a class="src rightside" href="../../src/arrow_array/array/list_array.rs.html#44">Source</a><h4 class="code-header">const <a href="#associatedconstant.IS_LARGE" class="constant">IS_LARGE</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>True for 64 bit offset size and false for 32 bit offset size</p>
</div></details><details class="toggle" open><summary><section id="associatedconstant.PREFIX" class="method"><a class="src rightside" href="../../src/arrow_array/array/list_array.rs.html#46">Source</a><h4 class="code-header">const <a href="#associatedconstant.PREFIX" class="constant">PREFIX</a>: &amp;'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></summary><div class="docblock"><p>Prefix for the offset size</p>
</div></details><details class="toggle" open><summary><section id="associatedconstant.MAX_OFFSET" class="method"><a class="src rightside" href="../../src/arrow_array/array/list_array.rs.html#48">Source</a><h4 class="code-header">const <a href="#associatedconstant.MAX_OFFSET" class="constant">MAX_OFFSET</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>The max <code>usize</code> offset</p>
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-OffsetSizeTrait-for-i32" class="impl"><a class="src rightside" href="../../src/arrow_array/array/list_array.rs.html#51-55">Source</a><a href="#impl-OffsetSizeTrait-for-i32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.OffsetSizeTrait.html" title="trait arrow_array::array::OffsetSizeTrait">OffsetSizeTrait</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.IS_LARGE-1" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/arrow_array/array/list_array.rs.html#52">Source</a><a href="#associatedconstant.IS_LARGE-1" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.IS_LARGE" class="constant">IS_LARGE</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> = false</h4></section><section id="associatedconstant.PREFIX-1" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/arrow_array/array/list_array.rs.html#53">Source</a><a href="#associatedconstant.PREFIX-1" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.PREFIX" class="constant">PREFIX</a>: &amp;'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a> = &quot;&quot;</h4></section><section id="associatedconstant.MAX_OFFSET-1" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/arrow_array/array/list_array.rs.html#54">Source</a><a href="#associatedconstant.MAX_OFFSET-1" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.MAX_OFFSET" class="constant">MAX_OFFSET</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a> = 2_147_483_647usize</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-OffsetSizeTrait-for-i64" class="impl"><a class="src rightside" href="../../src/arrow_array/array/list_array.rs.html#57-61">Source</a><a href="#impl-OffsetSizeTrait-for-i64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.OffsetSizeTrait.html" title="trait arrow_array::array::OffsetSizeTrait">OffsetSizeTrait</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.IS_LARGE-2" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/arrow_array/array/list_array.rs.html#58">Source</a><a href="#associatedconstant.IS_LARGE-2" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.IS_LARGE" class="constant">IS_LARGE</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> = true</h4></section><section id="associatedconstant.PREFIX-2" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/arrow_array/array/list_array.rs.html#59">Source</a><a href="#associatedconstant.PREFIX-2" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.PREFIX" class="constant">PREFIX</a>: &amp;'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a> = &quot;Large&quot;</h4></section><section id="associatedconstant.MAX_OFFSET-2" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/arrow_array/array/list_array.rs.html#60">Source</a><a href="#associatedconstant.MAX_OFFSET-2" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.MAX_OFFSET" class="constant">MAX_OFFSET</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a> = 9_223_372_036_854_775_807usize</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/arrow_array/array/list_array/trait.OffsetSizeTrait.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html>