blob: 6facd0b52d9aa4dea2e81f0be516928c6a051035 [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="Zero-sized types used to parameterize generic array implementations"><title>arrow_array::types - 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_array" 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_array/index.html">arrow_array</a><span class="version">51.0.0</span></h2></div><h2 class="location"><a href="#">Module types</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In crate arrow_array</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_array</a>::<wbr><a class="mod" href="#">types</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_array/types.rs.html#18-1706">source</a> ยท <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Zero-sized types used to parameterize generic array implementations</p>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">ยง</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="byte_view/index.html" title="mod arrow_array::types::byte_view">byte_view</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div></li><li><div class="item-name"><a class="mod" href="bytes/index.html" title="mod arrow_array::types::bytes">bytes</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div><div class="desc docblock-short">Crate private types for Byte Arrays</div></li><li><div class="item-name"><a class="mod" href="decimal/index.html" title="mod arrow_array::types::decimal">decimal</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div><div class="desc docblock-short">Crate private types for Decimal Arrays</div></li><li><div class="item-name"><a class="mod" href="primitive/index.html" title="mod arrow_array::types::primitive">primitive</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div></li></ul><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.make_type.html" title="macro arrow_array::types::make_type">make_type</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">ยง</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.BinaryViewType.html" title="struct arrow_array::types::BinaryViewType">BinaryViewType</a></div><div class="desc docblock-short"><a href="struct.BinaryViewType.html" title="struct arrow_array::types::BinaryViewType"><code>BinaryViewType</code></a> for string arrays</div></li><li><div class="item-name"><a class="struct" href="struct.BooleanType.html" title="struct arrow_array::types::BooleanType">BooleanType</a></div><div class="desc docblock-short">A boolean datatype</div></li><li><div class="item-name"><a class="struct" href="struct.Date32Type.html" title="struct arrow_array::types::Date32Type">Date32Type</a></div><div class="desc docblock-short">A 32-bit date type representing the elapsed time since UNIX epoch in days(32 bits).</div></li><li><div class="item-name"><a class="struct" href="struct.Date64Type.html" title="struct arrow_array::types::Date64Type">Date64Type</a></div><div class="desc docblock-short">A 64-bit date type representing the elapsed time since UNIX epoch in milliseconds(64 bits).</div></li><li><div class="item-name"><a class="struct" href="struct.Decimal128Type.html" title="struct arrow_array::types::Decimal128Type">Decimal128Type</a></div><div class="desc docblock-short">The decimal type for a Decimal128Array</div></li><li><div class="item-name"><a class="struct" href="struct.Decimal256Type.html" title="struct arrow_array::types::Decimal256Type">Decimal256Type</a></div><div class="desc docblock-short">The decimal type for a Decimal256Array</div></li><li><div class="item-name"><a class="struct" href="struct.DurationMicrosecondType.html" title="struct arrow_array::types::DurationMicrosecondType">DurationMicrosecondType</a></div><div class="desc docblock-short">An elapsed time type in microseconds.</div></li><li><div class="item-name"><a class="struct" href="struct.DurationMillisecondType.html" title="struct arrow_array::types::DurationMillisecondType">DurationMillisecondType</a></div><div class="desc docblock-short">An elapsed time type in milliseconds.</div></li><li><div class="item-name"><a class="struct" href="struct.DurationNanosecondType.html" title="struct arrow_array::types::DurationNanosecondType">DurationNanosecondType</a></div><div class="desc docblock-short">An elapsed time type in nanoseconds.</div></li><li><div class="item-name"><a class="struct" href="struct.DurationSecondType.html" title="struct arrow_array::types::DurationSecondType">DurationSecondType</a></div><div class="desc docblock-short">An elapsed time type in seconds.</div></li><li><div class="item-name"><a class="struct" href="struct.Float16Type.html" title="struct arrow_array::types::Float16Type">Float16Type</a></div><div class="desc docblock-short">A 16-bit floating point number type.</div></li><li><div class="item-name"><a class="struct" href="struct.Float32Type.html" title="struct arrow_array::types::Float32Type">Float32Type</a></div><div class="desc docblock-short">A 32-bit floating point number type.</div></li><li><div class="item-name"><a class="struct" href="struct.Float64Type.html" title="struct arrow_array::types::Float64Type">Float64Type</a></div><div class="desc docblock-short">A 64-bit floating point number type.</div></li><li><div class="item-name"><a class="struct" href="struct.GenericBinaryType.html" title="struct arrow_array::types::GenericBinaryType">GenericBinaryType</a></div><div class="desc docblock-short"><a href="trait.ByteArrayType.html" title="trait arrow_array::types::ByteArrayType"><code>ByteArrayType</code></a> for binary arrays</div></li><li><div class="item-name"><a class="struct" href="struct.GenericStringType.html" title="struct arrow_array::types::GenericStringType">GenericStringType</a></div><div class="desc docblock-short"><a href="trait.ByteArrayType.html" title="trait arrow_array::types::ByteArrayType"><code>ByteArrayType</code></a> for string arrays</div></li><li><div class="item-name"><a class="struct" href="struct.Int8Type.html" title="struct arrow_array::types::Int8Type">Int8Type</a></div><div class="desc docblock-short">A signed 8-bit integer type.</div></li><li><div class="item-name"><a class="struct" href="struct.Int16Type.html" title="struct arrow_array::types::Int16Type">Int16Type</a></div><div class="desc docblock-short">A signed 16-bit integer type.</div></li><li><div class="item-name"><a class="struct" href="struct.Int32Type.html" title="struct arrow_array::types::Int32Type">Int32Type</a></div><div class="desc docblock-short">A signed 32-bit integer type.</div></li><li><div class="item-name"><a class="struct" href="struct.Int64Type.html" title="struct arrow_array::types::Int64Type">Int64Type</a></div><div class="desc docblock-short">A signed 64-bit integer type.</div></li><li><div class="item-name"><a class="struct" href="struct.IntervalDayTimeType.html" title="struct arrow_array::types::IntervalDayTimeType">IntervalDayTimeType</a></div><div class="desc docblock-short">A โ€œcalendarโ€ interval type in days and milliseconds.</div></li><li><div class="item-name"><a class="struct" href="struct.IntervalMonthDayNanoType.html" title="struct arrow_array::types::IntervalMonthDayNanoType">IntervalMonthDayNanoType</a></div><div class="desc docblock-short">A โ€œcalendarโ€ interval type in months, days, and nanoseconds.</div></li><li><div class="item-name"><a class="struct" href="struct.IntervalYearMonthType.html" title="struct arrow_array::types::IntervalYearMonthType">IntervalYearMonthType</a></div><div class="desc docblock-short">A โ€œcalendarโ€ interval stored as the number of whole months.</div></li><li><div class="item-name"><a class="struct" href="struct.StringViewType.html" title="struct arrow_array::types::StringViewType">StringViewType</a></div><div class="desc docblock-short"><a href="trait.ByteViewType.html" title="trait arrow_array::types::ByteViewType"><code>ByteViewType</code></a> for string arrays</div></li><li><div class="item-name"><a class="struct" href="struct.Time32MillisecondType.html" title="struct arrow_array::types::Time32MillisecondType">Time32MillisecondType</a></div><div class="desc docblock-short">A 32-bit time type representing the elapsed time since midnight in milliseconds.</div></li><li><div class="item-name"><a class="struct" href="struct.Time32SecondType.html" title="struct arrow_array::types::Time32SecondType">Time32SecondType</a></div><div class="desc docblock-short">A 32-bit time type representing the elapsed time since midnight in seconds.</div></li><li><div class="item-name"><a class="struct" href="struct.Time64MicrosecondType.html" title="struct arrow_array::types::Time64MicrosecondType">Time64MicrosecondType</a></div><div class="desc docblock-short">A 64-bit time type representing the elapsed time since midnight in microseconds.</div></li><li><div class="item-name"><a class="struct" href="struct.Time64NanosecondType.html" title="struct arrow_array::types::Time64NanosecondType">Time64NanosecondType</a></div><div class="desc docblock-short">A 64-bit time type representing the elapsed time since midnight in nanoseconds.</div></li><li><div class="item-name"><a class="struct" href="struct.TimestampMicrosecondType.html" title="struct arrow_array::types::TimestampMicrosecondType">TimestampMicrosecondType</a></div><div class="desc docblock-short">A timestamp microsecond type with an optional timezone.</div></li><li><div class="item-name"><a class="struct" href="struct.TimestampMillisecondType.html" title="struct arrow_array::types::TimestampMillisecondType">TimestampMillisecondType</a></div><div class="desc docblock-short">A timestamp millisecond type with an optional timezone.</div></li><li><div class="item-name"><a class="struct" href="struct.TimestampNanosecondType.html" title="struct arrow_array::types::TimestampNanosecondType">TimestampNanosecondType</a></div><div class="desc docblock-short">A timestamp nanosecond type with an optional timezone.</div></li><li><div class="item-name"><a class="struct" href="struct.TimestampSecondType.html" title="struct arrow_array::types::TimestampSecondType">TimestampSecondType</a></div><div class="desc docblock-short">A timestamp second type with an optional timezone.</div></li><li><div class="item-name"><a class="struct" href="struct.UInt8Type.html" title="struct arrow_array::types::UInt8Type">UInt8Type</a></div><div class="desc docblock-short">An unsigned 8-bit integer type.</div></li><li><div class="item-name"><a class="struct" href="struct.UInt16Type.html" title="struct arrow_array::types::UInt16Type">UInt16Type</a></div><div class="desc docblock-short">An unsigned 16-bit integer type.</div></li><li><div class="item-name"><a class="struct" href="struct.UInt32Type.html" title="struct arrow_array::types::UInt32Type">UInt32Type</a></div><div class="desc docblock-short">An unsigned 32-bit integer type.</div></li><li><div class="item-name"><a class="struct" href="struct.UInt64Type.html" title="struct arrow_array::types::UInt64Type">UInt64Type</a></div><div class="desc docblock-short">An unsigned 64-bit integer type.</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.ArrowDictionaryKeyType.html" title="trait arrow_array::types::ArrowDictionaryKeyType">ArrowDictionaryKeyType</a></div><div class="desc docblock-short">A subtype of primitive type that represents legal dictionary keys.
See <a href="https://arrow.apache.org/docs/format/Columnar.html">https://arrow.apache.org/docs/format/Columnar.html</a></div></li><li><div class="item-name"><a class="trait" href="trait.ArrowPrimitiveType.html" title="trait arrow_array::types::ArrowPrimitiveType">ArrowPrimitiveType</a></div><div class="desc docblock-short">Trait bridging the dynamic-typed nature of Arrow (via <a href="../../arrow_schema/datatype/enum.DataType.html" title="enum arrow_schema::datatype::DataType"><code>DataType</code></a>) with the
static-typed nature of rust types (<a href="arrow_buffer::ArrowNativeType"><code>ArrowNativeType</code></a>) for all types that implement <a href="arrow_buffer::ArrowNativeType"><code>ArrowNativeType</code></a>.</div></li><li><div class="item-name"><a class="trait" href="trait.ArrowTemporalType.html" title="trait arrow_array::types::ArrowTemporalType">ArrowTemporalType</a></div><div class="desc docblock-short">A subtype of primitive type that represents temporal values.</div></li><li><div class="item-name"><a class="trait" href="trait.ArrowTimestampType.html" title="trait arrow_array::types::ArrowTimestampType">ArrowTimestampType</a></div><div class="desc docblock-short">A timestamp type allows us to create array builders that take a timestamp.</div></li><li><div class="item-name"><a class="trait" href="trait.ByteArrayType.html" title="trait arrow_array::types::ByteArrayType">ByteArrayType</a></div><div class="desc docblock-short">A trait over the variable-size byte array types</div></li><li><div class="item-name"><a class="trait" href="trait.ByteViewType.html" title="trait arrow_array::types::ByteViewType">ByteViewType</a></div><div class="desc docblock-short">A trait over the variable length bytes view array types</div></li><li><div class="item-name"><a class="trait" href="trait.DecimalType.html" title="trait arrow_array::types::DecimalType">DecimalType</a></div><div class="desc docblock-short">A trait over the decimal types, used by <a href="../array/primitive_array/struct.PrimitiveArray.html" title="struct arrow_array::array::primitive_array::PrimitiveArray"><code>PrimitiveArray</code></a> to provide a generic
implementation across the various decimal types</div></li><li><div class="item-name"><a class="trait" href="trait.RunEndIndexType.html" title="trait arrow_array::types::RunEndIndexType">RunEndIndexType</a></div><div class="desc docblock-short">A subtype of primitive type that is used as run-ends index
in <code>RunArray</code>.
See <a href="https://arrow.apache.org/docs/format/Columnar.html">https://arrow.apache.org/docs/format/Columnar.html</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.add_day_time.html" title="fn arrow_array::types::add_day_time">add_day_time</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div></li><li><div class="item-name"><a class="fn" href="fn.add_month_day_nano.html" title="fn arrow_array::types::add_month_day_nano">add_month_day_nano</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div></li><li><div class="item-name"><a class="fn" href="fn.add_year_months.html" title="fn arrow_array::types::add_year_months">add_year_months</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div></li><li><div class="item-name"><a class="fn" href="fn.format_decimal_str.html" title="fn arrow_array::types::format_decimal_str">format_decimal_str</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div></li><li><div class="item-name"><a class="fn" href="fn.subtract_day_time.html" title="fn arrow_array::types::subtract_day_time">subtract_day_time</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div></li><li><div class="item-name"><a class="fn" href="fn.subtract_month_day_nano.html" title="fn arrow_array::types::subtract_month_day_nano">subtract_month_day_nano</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div></li><li><div class="item-name"><a class="fn" href="fn.subtract_year_months.html" title="fn arrow_array::types::subtract_year_months">subtract_year_months</a><span title="Restricted Visibility">&nbsp;๐Ÿ”’</span> </div></li><li><div class="item-name"><a class="fn" href="fn.validate_decimal_precision_and_scale.html" title="fn arrow_array::types::validate_decimal_precision_and_scale">validate_decimal_precision_and_scale</a></div><div class="desc docblock-short">Validate that <code>precision</code> and <code>scale</code> are valid for <code>T</code></div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">ยง</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.BinaryType.html" title="type arrow_array::types::BinaryType">BinaryType</a></div><div class="desc docblock-short">An arrow binary array with i32 offsets</div></li><li><div class="item-name"><a class="type" href="type.LargeBinaryType.html" title="type arrow_array::types::LargeBinaryType">LargeBinaryType</a></div><div class="desc docblock-short">An arrow binary array with i64 offsets</div></li><li><div class="item-name"><a class="type" href="type.LargeUtf8Type.html" title="type arrow_array::types::LargeUtf8Type">LargeUtf8Type</a></div><div class="desc docblock-short">An arrow utf8 array with i64 offsets</div></li><li><div class="item-name"><a class="type" href="type.Utf8Type.html" title="type arrow_array::types::Utf8Type">Utf8Type</a></div><div class="desc docblock-short">An arrow utf8 array with i32 offsets</div></li></ul></section></div></main></body></html>