Files
greptimedb/common_meta/key/flow/flow_state/index.html
2026-03-13 04:38:03 +00:00

1 line
5.3 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 `flow_state` mod in crate `common_meta`."><title>common_meta::key::flow::flow_state - 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="common_meta" 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 flow_state</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../common_meta/index.html">common_<wbr>meta</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 flow_<wbr>state</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="#constants" title="Constants">Constants</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 common_<wbr>meta::<wbr>key::<wbr>flow</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">common_meta</a>::<wbr><a href="../../index.html">key</a>::<wbr><a href="../index.html">flow</a></div><h1>Module <span>flow_<wbr>state</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/common_meta/key/flow/flow_state.rs.html#15-174">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.FlowStat.html" title="struct common_meta::key::flow::flow_state::FlowStat">Flow<wbr>Stat</a></dt><dd>Flows state report, send regularly through heartbeat message</dd><dt><a class="struct" href="struct.FlowStateKey.html" title="struct common_meta::key::flow::flow_state::FlowStateKey">Flow<wbr>State<wbr>Key</a></dt><dd>The key stores the state size of the flow.</dd><dt><a class="struct" href="struct.FlowStateKeyInner.html" title="struct common_meta::key::flow::flow_state::FlowStateKeyInner">Flow<wbr>State<wbr>KeyInner</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The key of flow state.</dd><dt><a class="struct" href="struct.FlowStateManager.html" title="struct common_meta::key::flow::flow_state::FlowStateManager">Flow<wbr>State<wbr>Manager</a></dt><dd>The manager of <a href="struct.FlowStateKey.html" title="struct common_meta::key::flow::flow_state::FlowStateKey">FlowStateKey</a>. Since state size changes frequently, we store it in memory.</dd><dt><a class="struct" href="struct.FlowStateValue.html" title="struct common_meta::key::flow::flow_state::FlowStateValue">Flow<wbr>State<wbr>Value</a></dt><dd>The value of flow state size</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.FLOW_STATE_KEY.html" title="constant common_meta::key::flow::flow_state::FLOW_STATE_KEY">FLOW_<wbr>STATE_<wbr>KEY</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The entire FlowId to Flow Sizes Map is stored directly in the value part of the key.</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.FlowStateManagerRef.html" title="type common_meta::key::flow::flow_state::FlowStateManagerRef">Flow<wbr>State<wbr>Manager<wbr>Ref</a></dt></dl></section></div></main></body></html>