blob: e313ad5d69c70d64fb040c9468ae3f025735643b [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 `list_array` mod in crate `arrow_array`."><title>arrow_array::array::list_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.93.0-nightly (2286e5d22 2025-11-13)" data-channel="nightly" data-search-js="search-680b2199.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-a410ff4d.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 mod"><!--[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="#">Module list_array</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="#">Module list_<wbr>array</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></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>Module <span>list_<wbr>array</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#18-1287">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.GenericListArray.html" title="struct arrow_array::array::list_array::GenericListArray">Generic<wbr>List<wbr>Array</a></dt><dd>An array of <a href="https://arrow.apache.org/docs/format/Columnar.html#variable-size-list-layout">variable length lists</a>, similar to JSON arrays
(e.g. <code>["A", "B", "C"]</code>). This struct specifically represents
the <a href="https://arrow.apache.org/docs/format/Columnar.html#list-layout">list layout</a>. Refer to <a href="../struct.GenericListViewArray.html" title="struct arrow_array::array::GenericListViewArray"><code>GenericListViewArray</code></a> for the
<a href="https://arrow.apache.org/docs/format/Columnar.html#listview-layout">list-view layout</a>.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.OffsetSizeTrait.html" title="trait arrow_array::array::list_array::OffsetSizeTrait">Offset<wbr>Size<wbr>Trait</a></dt><dd>A type that can be used within a variable-size array to encode offset information</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.LargeListArray.html" title="type arrow_array::array::list_array::LargeListArray">Large<wbr>List<wbr>Array</a></dt><dd>A <a href="../struct.GenericListArray.html" title="struct arrow_array::array::GenericListArray"><code>GenericListArray</code></a> of variable size lists, storing offsets as <code>i64</code>.</dd><dt><a class="type" href="type.ListArray.html" title="type arrow_array::array::list_array::ListArray">List<wbr>Array</a></dt><dd>A <a href="../struct.GenericListArray.html" title="struct arrow_array::array::GenericListArray"><code>GenericListArray</code></a> of variable size lists, storing offsets as <code>i32</code>.</dd></dl></section></div></main></body></html>