rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2026-05-16 13:00:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2c331a8643edcda236a263ab5dd73ec218e2e72f
greptimedb/store_api/storage/descriptors/index.html
github-merge-queue[bot] 2c331a8643 Deploying to gh-pages from @ GreptimeTeam/greptimedb@0572a680af 🚀
2026-03-13 04:38:03 +00:00

3 lines
7.1 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `descriptors` mod in crate `store_api`."><title>store_api::storage::descriptors - 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="store_api" 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 descriptors</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../store_api/index.html">store_<wbr>api</a><span class="version">1.0.0-rc.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module descriptors</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="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</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 store_<wbr>api::<wbr>storage</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">store_api</a>::<wbr><a href="../index.html">storage</a></div><h1>Module <span>descriptors</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/store_api/storage/descriptors.rs.html#15-372">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.ColumnDescriptor.html" title="struct store_api::storage::descriptors::ColumnDescriptor">Column<wbr>Descriptor</a></dt><dd>A <a href="../struct.ColumnDescriptor.html" title="struct store_api::storage::ColumnDescriptor">ColumnDescriptor</a> contains information to create a column.</dd><dt><a class="struct" href="struct.ColumnDescriptorBuilder.html" title="struct store_api::storage::descriptors::ColumnDescriptorBuilder">Column<wbr>Descriptor<wbr>Builder</a></dt><dd>Builder for <a href="struct.ColumnDescriptor.html"><code>ColumnDescriptor</code></a>.</dd><dt><a class="struct" href="struct.RegionId.html" title="struct store_api::storage::descriptors::RegionId">Region<wbr>Id</a></dt><dd>Id of the region. It’s generated by concatenating table id, region group and region number.</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.ColumnDescriptorBuilderError.html" title="enum store_api::storage::descriptors::ColumnDescriptorBuilderError">Column<wbr>Descriptor<wbr>Builder<wbr>Error</a></dt><dd>Error type for ColumnDescriptorBuilder</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.MAX_REGION_SEQ.html" title="constant store_api::storage::descriptors::MAX_REGION_SEQ">MAX_<wbr>REGION_<wbr>SEQ</a></dt><dd>The max valid region sequence number.</dd><dt><a class="constant" href="constant.REGION_GROUP_MASK.html" title="constant store_api::storage::descriptors::REGION_GROUP_MASK">REGION_<wbr>GROUP_<wbr>MASK</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.REGION_SEQ_MASK.html" title="constant store_api::storage::descriptors::REGION_SEQ_MASK">REGION_<wbr>SEQ_<wbr>MASK</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></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.str_or_u64.html" title="fn store_api::storage::descriptors::str_or_u64">str_<wbr>or_<wbr>u64</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>FIXME(discord9): workaround for serde issue: https://github.com/serde-rs/json/issues/1254</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.ColumnId.html" title="type store_api::storage::descriptors::ColumnId">Column<wbr>Id</a></dt><dd>Id of column. Unique in each region.</dd><dt><a class="type" href="type.RegionGroup.html" title="type store_api::storage::descriptors::RegionGroup">Region<wbr>Group</a></dt><dd>Group number of one region. Unique in each region.</dd><dt><a class="type" href="type.RegionNumber.html" title="type store_api::storage::descriptors::RegionNumber">Region<wbr>Number</a></dt><dd>Id of regions under the same table. Unique in each table.
Is composed by <a href="../type.RegionGroup.html" title="type store_api::storage::RegionGroup">RegionGroup</a> and <a href="../type.RegionSeq.html" title="type store_api::storage::RegionSeq">RegionSeq</a>.</dd><dt><a class="type" href="type.RegionSeq.html" title="type store_api::storage::descriptors::RegionSeq">Region<wbr>Seq</a></dt><dd>Sequence number of region inside one table. Unique in each table.
The first 8 bits are preserved for <a href="../type.RegionGroup.html" title="type store_api::storage::RegionGroup">RegionGroup</a>.</dd><dt><a class="type" href="type.TableId.html" title="type store_api::storage::descriptors::TableId">TableId</a></dt><dd>Id of table. Universal unique.</dd></dl></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink