| <!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 trait over the variable-size byte array types"><title>ByteArrayType in arrow::datatypes - 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" 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 trait"><!--[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/index.html">arrow</a><span class="version">51.0.0</span></h2></div><h2 class="location"><a href="#">ByteArrayType</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Native">Native</a></li><li><a href="#associatedtype.Offset">Offset</a></li></ul><h3><a href="#required-associated-consts">Required Associated Constants</a></h3><ul class="block"><li><a href="#associatedconstant.DATA_TYPE">DATA_TYPE</a></li><li><a href="#associatedconstant.PREFIX">PREFIX</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.validate">validate</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In arrow::datatypes</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>Trait <a href="../index.html">arrow</a>::<wbr><a href="index.html">datatypes</a>::<wbr><a class="trait" href="#">ByteArrayType</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait ByteArrayType: 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + ByteArrayTypeSealed { |
| type <a href="#associatedtype.Offset" class="associatedtype">Offset</a>: <a class="trait" href="../array/trait.OffsetSizeTrait.html" title="trait arrow::array::OffsetSizeTrait">OffsetSizeTrait</a>; |
| type <a href="#associatedtype.Native" class="associatedtype">Native</a>: ByteArrayNativeType + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><Self::<a class="associatedtype" href="trait.ByteArrayType.html#associatedtype.Native" title="type arrow::datatypes::ByteArrayType::Native">Native</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>; |
| |
| const <a href="#associatedconstant.PREFIX" class="constant">PREFIX</a>: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>; |
| const <a href="#associatedconstant.DATA_TYPE" class="constant">DATA_TYPE</a>: <a class="enum" href="enum.DataType.html" title="enum arrow::datatypes::DataType">DataType</a>; |
| |
| // Required method |
| fn <a href="#tymethod.validate" class="fn">validate</a>( |
| offsets: &<a class="struct" href="../buffer/struct.OffsetBuffer.html" title="struct arrow::buffer::OffsetBuffer">OffsetBuffer</a><Self::<a class="associatedtype" href="trait.ByteArrayType.html#associatedtype.Offset" title="type arrow::datatypes::ByteArrayType::Offset">Offset</a>>, |
| values: &<a class="struct" href="../buffer/struct.Buffer.html" title="struct arrow::buffer::Buffer">Buffer</a> |
| ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../error/enum.ArrowError.html" title="enum arrow::error::ArrowError">ArrowError</a>>; |
| }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait over the variable-size byte array types</p> |
| <p>See <a href="https://arrow.apache.org/docs/format/Columnar.html#variable-size-binary-layout">Variable Size Binary Layout</a></p> |
| </div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Offset" class="method"><h4 class="code-header">type <a href="#associatedtype.Offset" class="associatedtype">Offset</a>: <a class="trait" href="../array/trait.OffsetSizeTrait.html" title="trait arrow::array::OffsetSizeTrait">OffsetSizeTrait</a></h4></section></summary><div class="docblock"><p>Type of offset i.e i32/i64</p> |
| </div></details><details class="toggle" open><summary><section id="associatedtype.Native" class="method"><h4 class="code-header">type <a href="#associatedtype.Native" class="associatedtype">Native</a>: ByteArrayNativeType + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><Self::<a class="associatedtype" href="trait.ByteArrayType.html#associatedtype.Native" title="type arrow::datatypes::ByteArrayType::Native">Native</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></h4></section></summary><div class="docblock"><p>Type for representing its equivalent rust type i.e |
| Utf8Array will have native type has &str |
| BinaryArray will have type as <a href="https://doc.rust-lang.org/nightly/std/primitive.u8.html" title="primitive u8">u8</a></p> |
| </div></details></div><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.PREFIX" class="method"><h4 class="code-header">const <a href="#associatedconstant.PREFIX" class="constant">PREFIX</a>: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></summary><div class="docblock"><p>“Binary” or “String”, for use in error messages</p> |
| </div></details><details class="toggle" open><summary><section id="associatedconstant.DATA_TYPE" class="method"><h4 class="code-header">const <a href="#associatedconstant.DATA_TYPE" class="constant">DATA_TYPE</a>: <a class="enum" href="enum.DataType.html" title="enum arrow::datatypes::DataType">DataType</a></h4></section></summary><div class="docblock"><p>Datatype of array elements</p> |
| </div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.validate" class="method"><h4 class="code-header">fn <a href="#tymethod.validate" class="fn">validate</a>( |
| offsets: &<a class="struct" href="../buffer/struct.OffsetBuffer.html" title="struct arrow::buffer::OffsetBuffer">OffsetBuffer</a><Self::<a class="associatedtype" href="trait.ByteArrayType.html#associatedtype.Offset" title="type arrow::datatypes::ByteArrayType::Offset">Offset</a>>, |
| values: &<a class="struct" href="../buffer/struct.Buffer.html" title="struct arrow::buffer::Buffer">Buffer</a> |
| ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../error/enum.ArrowError.html" title="enum arrow::error::ArrowError">ArrowError</a>></h4></section></summary><div class="docblock"><p>Verifies that every consecutive pair of <code>offsets</code> denotes a valid slice of <code>values</code></p> |
| </div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-ByteArrayType-for-GenericBinaryType%3CO%3E" class="impl"><a href="#impl-ByteArrayType-for-GenericBinaryType%3CO%3E" class="anchor">§</a><h3 class="code-header">impl<O> <a class="trait" href="trait.ByteArrayType.html" title="trait arrow::datatypes::ByteArrayType">ByteArrayType</a> for <a class="struct" href="struct.GenericBinaryType.html" title="struct arrow::datatypes::GenericBinaryType">GenericBinaryType</a><O><div class="where">where |
| O: <a class="trait" href="../array/trait.OffsetSizeTrait.html" title="trait arrow::array::OffsetSizeTrait">OffsetSizeTrait</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Offset-1" class="associatedtype trait-impl"><a href="#associatedtype.Offset-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Offset" class="associatedtype">Offset</a> = O</h4></section><section id="associatedtype.Native-1" class="associatedtype trait-impl"><a href="#associatedtype.Native-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Native" class="associatedtype">Native</a> = [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]</h4></section><section id="associatedconstant.PREFIX-1" class="associatedconstant trait-impl"><a href="#associatedconstant.PREFIX-1" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.PREFIX" class="constant">PREFIX</a>: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a> = "Binary"</h4></section><section id="associatedconstant.DATA_TYPE-1" class="associatedconstant trait-impl"><a href="#associatedconstant.DATA_TYPE-1" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.DATA_TYPE" class="constant">DATA_TYPE</a>: <a class="enum" href="enum.DataType.html" title="enum arrow::datatypes::DataType">DataType</a> = _</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ByteArrayType-for-GenericStringType%3CO%3E" class="impl"><a href="#impl-ByteArrayType-for-GenericStringType%3CO%3E" class="anchor">§</a><h3 class="code-header">impl<O> <a class="trait" href="trait.ByteArrayType.html" title="trait arrow::datatypes::ByteArrayType">ByteArrayType</a> for <a class="struct" href="struct.GenericStringType.html" title="struct arrow::datatypes::GenericStringType">GenericStringType</a><O><div class="where">where |
| O: <a class="trait" href="../array/trait.OffsetSizeTrait.html" title="trait arrow::array::OffsetSizeTrait">OffsetSizeTrait</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Offset-2" class="associatedtype trait-impl"><a href="#associatedtype.Offset-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Offset" class="associatedtype">Offset</a> = O</h4></section><section id="associatedtype.Native-2" class="associatedtype trait-impl"><a href="#associatedtype.Native-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Native" class="associatedtype">Native</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section><section id="associatedconstant.PREFIX-2" class="associatedconstant trait-impl"><a href="#associatedconstant.PREFIX-2" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.PREFIX" class="constant">PREFIX</a>: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a> = "String"</h4></section><section id="associatedconstant.DATA_TYPE-2" class="associatedconstant trait-impl"><a href="#associatedconstant.DATA_TYPE-2" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.DATA_TYPE" class="constant">DATA_TYPE</a>: <a class="enum" href="enum.DataType.html" title="enum arrow::datatypes::DataType">DataType</a> = _</h4></section></div></details></div><script src="../../trait.impl/arrow_array/types/trait.ByteArrayType.js" data-ignore-extern-crates="arrow_array" async></script></section></div></main></body></html> |
