mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-04 12:22:55 +00:00
9 lines
16 KiB
HTML
9 lines
16 KiB
HTML
<!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 `types` mod in crate `datatypes`."><title>datatypes::types - 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-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="datatypes" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.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="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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 types</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../datatypes/index.html">datatypes</a><span class="version">1.0.0-beta.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module types</a></h2><h3><a href="#reexports">Module Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate datatypes</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">datatypes</a></div><h1>Module <span>types</span> <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/datatypes/types.rs.html#15-65">Source</a> </span></div><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.cast"><code>pub use cast::<a class="fn" href="cast/fn.cast.html" title="fn datatypes::types::cast::cast">cast</a>;</code></dt><dt id="reexport.cast_with_opt"><code>pub use cast::<a class="fn" href="cast/fn.cast_with_opt.html" title="fn datatypes::types::cast::cast_with_opt">cast_with_opt</a>;</code></dt><dt id="reexport.JSON_TYPE_NAME"><code>pub use json_type::<a class="constant" href="json_type/constant.JSON_TYPE_NAME.html" title="constant datatypes::types::json_type::JSON_TYPE_NAME">JSON_TYPE_NAME</a>;</code></dt><dt id="reexport.JsonFormat"><code>pub use json_type::<a class="enum" href="json_type/enum.JsonFormat.html" title="enum datatypes::types::json_type::JsonFormat">JsonFormat</a>;</code></dt><dt id="reexport.JsonType"><code>pub use json_type::<a class="struct" href="json_type/struct.JsonType.html" title="struct datatypes::types::json_type::JsonType">JsonType</a>;</code></dt><dt id="reexport.jsonb_to_serde_json"><code>pub use json_type::<a class="fn" href="json_type/fn.jsonb_to_serde_json.html" title="fn datatypes::types::json_type::jsonb_to_serde_json">jsonb_to_serde_json</a>;</code></dt><dt id="reexport.jsonb_to_string"><code>pub use json_type::<a class="fn" href="json_type/fn.jsonb_to_string.html" title="fn datatypes::types::json_type::jsonb_to_string">jsonb_to_string</a>;</code></dt><dt id="reexport.parse_string_to_jsonb"><code>pub use json_type::<a class="fn" href="json_type/fn.parse_string_to_jsonb.html" title="fn datatypes::types::json_type::parse_string_to_jsonb">parse_string_to_jsonb</a>;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="binary_type/index.html" title="mod datatypes::types::binary_type">binary_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="boolean_type/index.html" title="mod datatypes::types::boolean_type">boolean_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="cast/index.html" title="mod datatypes::types::cast">cast</a></dt><dt><a class="mod" href="date_type/index.html" title="mod datatypes::types::date_type">date_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="decimal_type/index.html" title="mod datatypes::types::decimal_type">decimal_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="dictionary_type/index.html" title="mod datatypes::types::dictionary_type">dictionary_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="duration_type/index.html" title="mod datatypes::types::duration_type">duration_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="interval_type/index.html" title="mod datatypes::types::interval_type">interval_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="json_type/index.html" title="mod datatypes::types::json_type">json_<wbr>type</a></dt><dt><a class="mod" href="list_type/index.html" title="mod datatypes::types::list_type">list_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="null_type/index.html" title="mod datatypes::types::null_type">null_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="primitive_type/index.html" title="mod datatypes::types::primitive_type">primitive_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="string_type/index.html" title="mod datatypes::types::string_type">string_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="struct_type/index.html" title="mod datatypes::types::struct_type">struct_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="time_type/index.html" title="mod datatypes::types::time_type">time_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>TimeType represents the elapsed time since midnight in the unit of <code>TimeUnit</code>.</dd><dt><a class="mod" href="timestamp_type/index.html" title="mod datatypes::types::timestamp_type">timestamp_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="vector_type/index.html" title="mod datatypes::types::vector_type">vector_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.BinaryType.html" title="struct datatypes::types::BinaryType">Binary<wbr>Type</a></dt><dt><a class="struct" href="struct.BooleanType.html" title="struct datatypes::types::BooleanType">Boolean<wbr>Type</a></dt><dt><a class="struct" href="struct.DateType.html" title="struct datatypes::types::DateType">Date<wbr>Type</a></dt><dd>Data type for Date (YYYY-MM-DD).</dd><dt><a class="struct" href="struct.Decimal128Type.html" title="struct datatypes::types::Decimal128Type">Decimal128<wbr>Type</a></dt><dd>Decimal type with precision and scale information.</dd><dt><a class="struct" href="struct.DictionaryType.html" title="struct datatypes::types::DictionaryType">Dictionary<wbr>Type</a></dt><dd>Used to represent the Dictionary datatype.</dd><dt><a class="struct" href="struct.DurationMicrosecondType.html" title="struct datatypes::types::DurationMicrosecondType">Duration<wbr>Microsecond<wbr>Type</a></dt><dt><a class="struct" href="struct.DurationMillisecondType.html" title="struct datatypes::types::DurationMillisecondType">Duration<wbr>Millisecond<wbr>Type</a></dt><dt><a class="struct" href="struct.DurationNanosecondType.html" title="struct datatypes::types::DurationNanosecondType">Duration<wbr>Nanosecond<wbr>Type</a></dt><dt><a class="struct" href="struct.DurationSecondType.html" title="struct datatypes::types::DurationSecondType">Duration<wbr>Second<wbr>Type</a></dt><dt><a class="struct" href="struct.Float32Type.html" title="struct datatypes::types::Float32Type">Float32<wbr>Type</a></dt><dt><a class="struct" href="struct.Float64Type.html" title="struct datatypes::types::Float64Type">Float64<wbr>Type</a></dt><dt><a class="struct" href="struct.Int8Type.html" title="struct datatypes::types::Int8Type">Int8<wbr>Type</a></dt><dt><a class="struct" href="struct.Int16Type.html" title="struct datatypes::types::Int16Type">Int16<wbr>Type</a></dt><dt><a class="struct" href="struct.Int32Type.html" title="struct datatypes::types::Int32Type">Int32<wbr>Type</a></dt><dt><a class="struct" href="struct.Int64Type.html" title="struct datatypes::types::Int64Type">Int64<wbr>Type</a></dt><dt><a class="struct" href="struct.IntervalDayTimeType.html" title="struct datatypes::types::IntervalDayTimeType">Interval<wbr>DayTime<wbr>Type</a></dt><dt><a class="struct" href="struct.IntervalMonthDayNanoType.html" title="struct datatypes::types::IntervalMonthDayNanoType">Interval<wbr>Month<wbr>DayNano<wbr>Type</a></dt><dt><a class="struct" href="struct.IntervalYearMonthType.html" title="struct datatypes::types::IntervalYearMonthType">Interval<wbr>Year<wbr>Month<wbr>Type</a></dt><dt><a class="struct" href="struct.ListType.html" title="struct datatypes::types::ListType">List<wbr>Type</a></dt><dd>Used to represent the List datatype.</dd><dt><a class="struct" href="struct.NullType.html" title="struct datatypes::types::NullType">Null<wbr>Type</a></dt><dt><a class="struct" href="struct.OrdPrimitive.html" title="struct datatypes::types::OrdPrimitive">OrdPrimitive</a></dt><dd>A new type for <a href="trait.WrapperType.html" title="trait datatypes::types::WrapperType">WrapperType</a>, complement the <code>Ord</code> feature for it.</dd><dt><a class="struct" href="struct.StringType.html" title="struct datatypes::types::StringType">String<wbr>Type</a></dt><dt><a class="struct" href="struct.StructField.html" title="struct datatypes::types::StructField">Struct<wbr>Field</a></dt><dt><a class="struct" href="struct.StructType.html" title="struct datatypes::types::StructType">Struct<wbr>Type</a></dt><dt><a class="struct" href="struct.TimeMicrosecondType.html" title="struct datatypes::types::TimeMicrosecondType">Time<wbr>Microsecond<wbr>Type</a></dt><dt><a class="struct" href="struct.TimeMillisecondType.html" title="struct datatypes::types::TimeMillisecondType">Time<wbr>Millisecond<wbr>Type</a></dt><dt><a class="struct" href="struct.TimeNanosecondType.html" title="struct datatypes::types::TimeNanosecondType">Time<wbr>Nanosecond<wbr>Type</a></dt><dt><a class="struct" href="struct.TimeSecondType.html" title="struct datatypes::types::TimeSecondType">Time<wbr>Second<wbr>Type</a></dt><dt><a class="struct" href="struct.TimestampMicrosecondType.html" title="struct datatypes::types::TimestampMicrosecondType">Timestamp<wbr>Microsecond<wbr>Type</a></dt><dt><a class="struct" href="struct.TimestampMillisecondType.html" title="struct datatypes::types::TimestampMillisecondType">Timestamp<wbr>Millisecond<wbr>Type</a></dt><dt><a class="struct" href="struct.TimestampNanosecondType.html" title="struct datatypes::types::TimestampNanosecondType">Timestamp<wbr>Nanosecond<wbr>Type</a></dt><dt><a class="struct" href="struct.TimestampSecondType.html" title="struct datatypes::types::TimestampSecondType">Timestamp<wbr>Second<wbr>Type</a></dt><dt><a class="struct" href="struct.UInt8Type.html" title="struct datatypes::types::UInt8Type">UInt8<wbr>Type</a></dt><dt><a class="struct" href="struct.UInt16Type.html" title="struct datatypes::types::UInt16Type">UInt16<wbr>Type</a></dt><dt><a class="struct" href="struct.UInt32Type.html" title="struct datatypes::types::UInt32Type">UInt32<wbr>Type</a></dt><dt><a class="struct" href="struct.UInt64Type.html" title="struct datatypes::types::UInt64Type">UInt64<wbr>Type</a></dt><dt><a class="struct" href="struct.VectorType.html" title="struct datatypes::types::VectorType">Vector<wbr>Type</a></dt><dd><code>VectorType</code> is a data type for vector data with a fixed dimension.
|
|
The type of items in the vector is float32.
|
|
It is stored as binary data that contains the concatenated float32 values.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.DurationType.html" title="enum datatypes::types::DurationType">Duration<wbr>Type</a></dt><dt><a class="enum" href="enum.IntervalType.html" title="enum datatypes::types::IntervalType">Interval<wbr>Type</a></dt><dd>The “calendar” interval is a type of time interval that does not
|
|
have a precise duration without taking into account a specific
|
|
base timestamp.</dd><dt><a class="enum" href="enum.StringSizeType.html" title="enum datatypes::types::StringSizeType">String<wbr>Size<wbr>Type</a></dt><dd>String size variant to distinguish between UTF8 and LargeUTF8</dd><dt><a class="enum" href="enum.TimeType.html" title="enum datatypes::types::TimeType">Time<wbr>Type</a></dt><dt><a class="enum" href="enum.TimestampType.html" title="enum datatypes::types::TimestampType">Timestamp<wbr>Type</a></dt></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.LogicalPrimitiveType.html" title="trait datatypes::types::LogicalPrimitiveType">Logical<wbr>Primitive<wbr>Type</a></dt><dd>Trait bridging the logical primitive type with [ArrowPrimitiveType].</dd><dt><a class="trait" href="trait.WrapperType.html" title="trait datatypes::types::WrapperType">Wrapper<wbr>Type</a></dt><dd>Represents the wrapper type that wraps a native type using the <code>newtype pattern</code>,
|
|
such as <a href="%60common_time::Date%60">Date</a> is a wrapper type for the underlying native
|
|
type <code>i32</code>.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.parse_string_to_vector_type_value.html" title="fn datatypes::types::parse_string_to_vector_type_value">parse_<wbr>string_<wbr>to_<wbr>vector_<wbr>type_<wbr>value</a></dt><dd>Parses a string to a vector type value
|
|
Valid input format: “[1.0,2.0,3.0]”, “[1.0, 2.0, 3.0]”</dd><dt><a class="fn" href="fn.vector_type_value_to_string.html" title="fn datatypes::types::vector_type_value_to_string">vector_<wbr>type_<wbr>value_<wbr>to_<wbr>string</a></dt><dd>Converts a vector type value to string
|
|
for example: [1.0, 2.0, 3.0] -> “[1.0,2.0,3.0]”</dd></dl></section></div></main></body></html> |